Caputchin
集成指南

后端集成示例

服务端集成 就是一个普通的 JSON POST,所以任何语言里都没有第一方 SDK:用你后端已有的任何 HTTP 客户端就行。下面每个示例都发出你的密钥和来自表单的令牌,然后从响应里读取 success。它们全都假定密钥在一个环境变量里,绝不在代码里。

Node(fetch,自 18 起内置)

const res = await fetch("https://caputchin.com/api/v1/siteverify", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({ secret: process.env.CAPUTCHIN_SECRET, response: token }),
});
const result = await res.json();
if (!result.success) throw new Error("verification failed");

Python(requests

import os, requests

res = requests.post(
    "https://caputchin.com/api/v1/siteverify",
    json={"secret": os.environ["CAPUTCHIN_SECRET"], "response": token},
    timeout=10,
)
res.raise_for_status()
if not res.json()["success"]:
    raise RuntimeError("verification failed")

PHP(cURL)

$ch = curl_init("https://caputchin.com/api/v1/siteverify");
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ["Content-Type: application/json"],
    CURLOPT_POSTFIELDS => json_encode([
        "secret" => getenv("CAPUTCHIN_SECRET"),
        "response" => $token,
    ]),
]);
$result = json_decode(curl_exec($ch), true);
curl_close($ch);
if (!$result["success"]) throw new Exception("verification failed");

Go(net/http

body, _ := json.Marshal(map[string]string{
    "secret":   os.Getenv("CAPUTCHIN_SECRET"),
    "response": token,
})
res, err := http.Post("https://caputchin.com/api/v1/siteverify", "application/json", bytes.NewReader(body))
if err != nil {
    return err
}
defer res.Body.Close()
var result struct {
    Success bool `json:"success"`
}
json.NewDecoder(res.Body).Decode(&result)
if !result.Success {
    return fmt.Errorf("verification failed")
}

Ruby(Net::HTTP

require "net/http"
require "json"

uri = URI("https://caputchin.com/api/v1/siteverify")
res = Net::HTTP.post(
  uri,
  { secret: ENV["CAPUTCHIN_SECRET"], response: token }.to_json,
  "Content-Type" => "application/json",
)
raise "verification failed" unless JSON.parse(res.body)["success"]

.NET(HttpClient

using var http = new HttpClient();
var payload = JsonSerializer.Serialize(new {
    secret = Environment.GetEnvironmentVariable("CAPUTCHIN_SECRET"),
    response = token,
});
var res = await http.PostAsync(
    "https://caputchin.com/api/v1/siteverify",
    new StringContent(payload, Encoding.UTF8, "application/json"));
var result = JsonSerializer.Deserialize<JsonElement>(await res.Content.ReadAsStringAsync());
if (!result.GetProperty("success").GetBoolean()) throw new Exception("verification failed");

curl(用于快速测试)

curl -sS https://caputchin.com/api/v1/siteverify \
  -H "Content-Type: application/json" \
  -d "{\"secret\":\"$CAPUTCHIN_SECRET\",\"response\":\"$TOKEN\"}"

一个带类型的客户端

如果你宁愿用一个带类型的客户端,就把一个 OpenAPI 生成器指向 运行时 API 参考/siteverify 住在运行时规范里,而不是管理规范里。这个契约很小,所以生成的产物也很短。

另见

本页内容