KanutusDocs
kanutus.com Entrar / Criar contaEntrar

Referência da API

Esta referência é gerada a partir do arquivo OpenAPI 3.1 da API (também em https://api.kanutus.com/v1/openapi.json). Cada endpoint traz exemplos em curl, Node.js e Python, as respostas por status e um painel Testar agora, que chama a API de verdade com a sua chave de teste. Aperte / para buscar.

URL base

text
https://api.kanutus.com/v1

Autenticação

http
Authorization: Bearer kt_live_...

Use uma chave de API ou um token de acesso OAuth. Veja Autenticação.

Convenções

  • JSON na entrada e na saída (Content-Type: application/json). Datas em ISO 8601; horários em UTC, a não ser que tragam o fuso.
  • Requisições POST que criam algo precisam do Idempotency-Key (por quê).
  • Objetos criados com uma chave de teste vêm com "livemode": false.
  • Listas vêm no formato { "data": [...] }.
  • Erros: application/problem+json com um code estável (lista).

Endpoints

SDKs

Os SDKs oficiais em TypeScript e Python, gerados a partir deste arquivo, chegam em breve Em breve. Enquanto isso, o arquivo OpenAPI funciona com qualquer gerador, por exemplo o openapi-typescript ou o openapi-python-client.