你可以在请求中提供 API 密钥之一来认证 Ragic API。API 密钥具有许多权限,因此请务必保密!
当你的程序通过 API 密钥访问 Ragic 时,将基本上以 API 密钥用户的身份登录并运行读写操作。我们强烈建议为 API 密钥访问创建一个单独的用户帐号。这样 API 访问才不会与其他用户混淆,能让系统审核跟踪更方便,也将使你的 API 程序调试更加容易。
API 认证是通过 HTTP 基本认证进行的。提供你的 API 密钥作为基本身份验证的用户名称,不需要提供密码。
所有 API 请求必须通过 HTTPS 进行。通过普通 HTTP 发出的请求会失败。你必须为所有请求进行身份验证。
curl https://www.ragic.com/demo/sales/1\ --get -d api \ -H "Authorization:Basic YOUR_API_KEY_GOES_HERE"
请注意,HTTP 首部名称为 Authorization,值是你的 API 密钥,前面带有 "Basic ",Basic 后面有一个空格,你可能需要根据你的 Ragic 帐号 URL 将 URL 中的 www 修改为 na3、ap5 或 eu2等。
你可以在个人设置中生成你的 API 密钥。
大多数 HTTP 订户端(包括网页浏览器)会显示一个对话框或提示你提供用于 HTTP 基本认证的用户名称和密码(留空)。大多数订户端还许可你在 URL 中提供证书。
如果由于某种原因你无法将 API 密钥作为 HTTP 首部或基本身份验证发送,你可以将 API 密钥作为参数名为 APIKey 发送。你需要为你发送的每个请求增加此参数。
curl https://www.ragic.com/demo/sales/1\ --get -d api \ -d "APIKey=YOUR_API_KEY_GOES_HERE"