Skip to content
CurriculoCurriculo ATS DocumentationDocs
API referenceConsole

客户端 SDK

On this page

API是一份简单的REST，由OpenAPI的3.1文档描述，因此您可以通过一条命令为您的语言生成一个类型化的客户端，而不是依赖手写的SDK发布周期。

https://api.curriculo.me/public/openapi.json

该规范涵盖了同步操作和后台任务端点。但是， 的面试 端点尚未包含在内；您需要直接调用它们。

从规范生成类型化客户端

TypeScript：

npx @hey-api/openapi-ts -i https://api.curriculo.me/public/openapi.json -o src/curriculo-client

Python：

openapi-generator-cli generate -i https://api.curriculo.me/public/openapi.json \
  -g python -o ./curriculo-client

每个客户端必须执行的操作

  • 在每次调用时发送 Authorization: Bearer <credential> 。
  • 为文档操作保持请求超时时间超过五分钟。
  • 使用退避重试 429 和 503 。
  • 记录 X-Curriculo-Request-Id 响应头。

请参阅 身份验证，速率限制 和 错误.

交互式文档和Postman

  • Swagger UI: 使用自己的密钥运行任何同步操作以访问生产环境。
  • ReDoc: 同样的规范，以可读的参考形式呈现。
  • Postman: 导入上述的OpenAPI JSON，或从文档页面复制的cURL请求，位于 开发者控制台.

Updated