Skip to content

SDKs de cliente

On this page

O API é um REST simples descrito por um documento OpenAPI 3.1, então você gera um cliente tipado para sua linguagem em um comando em vez de depender de um ciclo de lançamento SDK escrito à mão.

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

A especificação abrange as operações síncronas e os endpoints de tarefas em segundo plano. Os endpoints de entrevista de de triagem ainda não estão incluídos; chame-os diretamente.

Gere um cliente tipado a partir da especificação

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

O que todo cliente deve fazer

  • Enviar Authorization: Bearer <credential> em cada chamada.
  • Manter um tempo de espera de solicitação acima de cinco minutos para as operações de documento.
  • Repetir 429 e 503 com retrocesso.
  • Registrar o cabeçalho de resposta X-Curriculo-Request-Id .

Consulte Autenticação,Limites de taxa e Erros.

Documentação interativa e Postman

  • Swagger UI: execute qualquer operação síncrona contra a produção com sua própria chave.
  • ReDoc: a mesma especificação, como uma referência legível.
  • Postman: importe o OpenAPI JSON acima, ou uma cURL solicitação copiada da página de documentação no Console do Desenvolvedor .

Updated