API

在实施自己的 Death By Captcha HTTP API客户端，请认真考虑使用上面列出的官方客户之一使用套接字API。

API URL是 http://api.dbcapi.me/api/. url路径根据所需的动作而变化。对API提出的请求的所有答复都有两个通用字段：

• status — 请求状态。 0如果内部请求处理过程中没有错误，则为255。
• error — 简短说明发生的错误。仅当状态为255时返回。

有关正确的URL路径和其他返回字段的特定操作的详细信息，请参阅下面的部分。

All API responses are returned URL-encoded by default. If JSON encoding is desired, include application/json in the Accept header of your request. Note that boolean true will be returned as 1 in URL-encoded responses and as true in JSON-encoded responses. Boolean false will be returned as 0 in URL-encoded responses and as false in JSON-encoded responses.

什么是“正常验证码”挑战？

这种形式的验证码是基于图像的，需要输入扭曲图像中的一系列字母或数字。

要上传验证码，请发出一个multipart/form-data的POST请求到 http://api.dbcapi.me/api/captcha. 该请求必须包含以下字段：

• username — 您的Death By Captcha用户名。
• password — 您的Death By Captcha密码。
• captchafile — 验证码图像。

如果您使用令牌身份验证：

• authtoken — 您的Death By Captcha身份验证令牌。
• captchafile — 验证码图像。

captchafile 应为原始 CAPTCHA 图像文件或以 base64: 前缀预置的 base64 编码的 CAPTCHA 图像。图像文件大小限制为小于 180 KB。当图像将编码为 base64 时，大小应小于 120 KB。支持的图像格式为 JPG、PNG、GIF 和 BMP。

这是解决问题的HTML形式：

<form action="http://api.dbcapi.me/api/captcha"method="post" enctype="multipart/form-data">
    <input type="text"     name="username" value="">
    <input type="password" name="password" value="">
    <input type="file"     name="captchafile">
</form>

或使用令牌身份验证：

<form action="http://api.dbcapi.me/api/captcha"method="post" enctype="multipart/form-data">
    <input type="text"     name="authtoken" value="">
    <input type="file"     name="captchafile">
</form>

这是curl命令等效：

curl --header 'Expect: ' -F username=YOUR_USERNAME  -F password=YOUR_PASSWORD  -F captchafile=@YOUR_CAPTCHA_FILENAME http://api.dbcapi.me/api/captcha

或使用令牌身份验证：

curl --header 'Expect: ' -F authtoken=YOUR_AUTHTOKEN  -F captchafile=@YOUR_CAPTCHA_FILENAME http://api.dbcapi.me/api/captcha

base64编码captchafile字段应该看起来像这样：

base64:R0lGODlhAQABAIABAAAAAP///yH5BAEAAAEALAAAAAABAAEAAAICTAEAOw==

您将获得以下HTTP响应之一：

• 303 See Other 如果您的验证码成功上传，会指向已上传的验证码状态页的HTTP头Location。 您可以跟随该Location以获取已上传的验证码状态。 另外，以下字段将返回：
  
  • captcha — 上载验证码的ID。
  • is_correct — 1如果已确定了该验证验的答案或仍在处理该答案，则0如果处理完成并且找不到答案。
  • text — 验证码答案。一个空字符串意味着验证码尚未解决。
  URL编码示例：

  status=0&captcha=123&is_correct=1&text=

  JSON编码示例：

  { "status": 0, "captcha": 123, "is_correct": 1, "text": "" }

• 403 Forbidden 如果您的Death By Captcha凭证的死亡被拒绝，或者您没有足够的信用。
• 400 Bad Request 如果您的请求未遵循上面的规范，或者因没有有效图像而被拒绝验证码。
• 500 Internal Server Error 如果我们一边发生了一些事情，阻止您上传验证码；如果您确定要使用有效的CATPCHA图像发送正确结构的请求，但问题仍然存在，请联系我们的实时支持，并详细告诉他们如何重现该问题。
• 503 Service Temporarily Unavailable 当我们的服务超载时，请稍后再试。

在这一点上，您刚刚上传的CAPTCHA可能尚未解决！如果您没有在服务器响应的text键中收到答案，则必须对其进行轮询。有关更多详细信息，请参见轮询已上传CAPTCHA状态。

要获得上传验证码的状态，请向 http://api.dbcapi.me/api/captcha/%CAPTCHA_ID%, 其中%CAPTCHA_ID%是您上传的验证码的ID，在上传验证码时获得. 这次您不必提供Death By Captcha凭据。 响应将是HTTP 200 OK响应，并包含与上传验证码部分的303 See Other响应中描述的相同字段。

如果尚未解决验证码，则text键将空。您将不得不继续进行此答案。示例响应：

• 正确求解的验证验的URL编码响应

  status=0&captcha=1234&is_correct=1&text=tyrone+slothrop

• JSON编码的正确解决的验证码的响应

  { "captcha": 1234, "is_correct": true,"status": 0, "text": "tyrone slothrop" }

• JSON编码的错误解决的验证码的响应

  { "captcha": 1234, "is_correct": false, "status": 0, "text": "?" }

• JSON编码的验证码的响应

  { "captcha": 0, "status": 0 }

  如果您得到此响应，请确认您用于轮询的验证码ID与上传时返回的答案相同。 如果问题仍然存在，请随时联系我们。

请不要在几秒钟内多次进行验证验证状态.
这被认为是滥用行为，可能会导致您被禁言。
请节约您和我们的带宽。

如果您认为您的验证码已被错误地解决，请将其报告给Death By Captcha以获取您的钱。 为此，请向http://api.dbcapi.me/api/captcha/%CAPTCHA_ID%/report发出邮政请求：

• username — 您的Death By Captcha用户名。
• password — 您的Death By Captcha密码。

或使用身份验证令牌:

• authtoken — 您的Death By Captcha身份验证令牌。

响应将是：

• 200 OK 如果报告完成。在这种情况下，您的贷方将被退还。响应主体将与民意调查（或上传）相同，但is_correct字段将为0。示例：

  { "captcha": 1234, "is_correct": false,"status": 0, "text": "tyrone slothrop" }

• 503 Service Unavailable 如果报告无法完成。这可能是因为：
  1）用户报告的验证码未上传与所提供的ID相对应；
  2）您的用户被禁止；
  3）报告已发布超过一个小时如果上传。在这种情况下，您不会退款。

滥用此功能将使您被禁止！

要查看您的信用余额，请在http://api.dbcapi.me/api上发布get或张贴请求。

• username — 您的Death By Captcha用户名。
• password — 您的Death By Captcha密码。

或使用身份验证令牌:

• authtoken — 您的Death By Captcha身份验证令牌。

成功验证后，您将获得200 OK响应并包含您的Death By Captcha帐户详细信息，可以是URL编码或JSON编码，包含以下字段：

• user — 您的Death By Captcha帐户ID；
• rate — 我们向您收取多少美分的正确解决验证码费用；
• balance — 您当前的信用余额，美分。
• is_banned — 1如果禁止用户，则0，如果不是。

示例JSON编码的响应：

{ "is_banned": false, "status": 0, "rate": 0.139,"balance": 455.23, "user": 43122 }