クライアントSDK
APIは、OpenAPI3.1ドキュメントによって記述されたプレーンのRESTです。したがって、手作業で書かれたSDKのリリースサイクルに依存するのではなく、1つのコマンドで言語用の型付きクライアントを生成できます。
https://api.curriculo.me/public/openapi.json仕様では、同期操作とバックグラウンドタスクエンドポイントがカバーされています。 スクリーニングインタビュー エンドポイントはまだ含まれていません。直接呼び出してください。
仕様から型付きクライアントを生成
TypeScript:
npx @hey-api/openapi-ts -i https://api.curriculo.me/public/openapi.json -o src/curriculo-clientPython:
openapi-generator-cli generate -i https://api.curriculo.me/public/openapi.json \
-g python -o ./curriculo-clientすべてのクライアントが実行する必要があること
- 毎回の呼び出しで
Authorization: Bearer <credential>を送信します. - ドキュメント操作のリクエストタイムアウトを5分以上に保ちます.
429と503をバックオフで再試行します.X-Curriculo-Request-Idレスポンスヘッダーをログに記録します.
認証、レート制限 、および エラーを参照してください..
インタラクティブなドキュメントと Postman
- Swagger UI: 自分のキーでプロダクションに対して任意の同期操作を実行します.
- ReDoc: 同じ仕様ですが、読みやすいリファレンスとして提供されます.
- Postman: 以上のOpenAPIJSONをインポートするか、 デベロッパーコンソールのドキュメントページからコピーしたcURLリクエスト.
Updated