API Key认证

豆瓣API Key认证

本文档提供豆瓣API Key认证的相关信息，如果你需要认证API Key以获得更宽松的访问限制，请详细阅读本文档。

关于API Key的更多信息，请访问这里。

当你为你的API Key申请了更宽松的访问限制之后，在访问非受限资源时就需要用API Key Secret对你的请求进行签名，用以认证你的API Key。

请保护好你的API Key Secret。一旦Secret丢失，你将无法防止你的API Key被滥用。我们也随时可能取消你API Key宽松的访问限制，甚至禁封你的API Key。

注：当你使用豆瓣OAuth 认证访问或修改有限资源时，不需要进行API Key认证。我们可以通过OAuth参数认证你的API Key并采用合适的访问限制策略。

API Key认证使用的签名方式，和OAuth规范中获取Request Token时使用的签名方式一致。

豆瓣OAuth认证示例项目中提供了常见语言环境下进行豆瓣OAuth认证的示例代码。这些代码中的第一步演示如何获得Request Token，其中通常也演示了如何使用API Key Secret对请求进行签名。

我们建议你阅读这些代码，并将其使用在你进行API Key认证的场景中——只需要将获取Request Token的url替换为你需要访问的url即可。

如果这些示例代码无法满足你的需要或者你所使用的语言不包含在示例项目中，那么你必须仔细阅读OAuth规范中获取Request Token和计算签名部分的内容，以便手工完成API Key认证——在此我们不再包含关于签名方法的完整文档。

该文档的中文版本，可以在这里找到。

记住，除了将获取Request Token的url替换为你需要访问的url之外，API Key认证签名方法和获取Request Token的签名方法完全一致。

注：尽可能使用一些OAuth库来简化计算签名的工作，以减少不必要的麻烦。Google-OAuth项目提供各种语言的OAuth库。