Pular para o conteúdo
Bitaloka Docs
Requisições e erros

Primeiros passos

Requisições e erros

Como cada endpoint da Bitaloka recebe dados e retorna resultados: aprenda uma vez e use em todo lugar.

URL base

URL base
https://api.bitaloka.io/v1

Todos os endpoints são versionados em /v1 e servidos apenas via HTTPS.

Envio de dados

  • Caminho: os identificadores vão direto na URL, p. ex. GET /v1/nik/{nik}.
  • Corpo JSON: os serviços de texto aceitam Content-Type: application/json.
  • Formulário multipart: as ferramentas de PDF e imagem aceitam multipart/form-data com file (ou vários files) e as opções como campos de texto.

O que é retornado

Analisadores, consultas e IA retornam JSON. As ferramentas de PDF retornam o arquivo processado (application/pdf, ou application/zip ao dividir): grave o corpo diretamente no disco.

Entrada inválida não é um erro

Um NIK malformado ainda recebe HTTP 200, com valid: false e uma lista errors que explica o motivo. Decida com base em valid, não no código de status.

GET /v1/nik/123 → 200 OK
{
  "valid": false,
  "input": "123",
  "normalized": "123",
  "gender": null,
  "birthDate": null,
  "region": null,
  "serial": null,
  "genderConsistent": false,
  "summary": "",
  "errors": [
    {
      "code": "INVALID_FORMAT",
      "message": "NIK must be exactly 16 digits"
    }
  ],
  "warnings": []
}

Erros

Falhas reais usam códigos de status HTTP padrão e um corpo JSON {"error": "…"}.

StatusSignificado
400Entrada ausente ou malformada; p. ex., nenhum arquivo ou um intervalo de páginas inválido.
401Chave de API ausente ou não reconhecida (quando as chaves forem obrigatórias).
413Arquivo maior que 60 MB.
503Uma dependência está temporariamente indisponível. Tente novamente com backoff exponencial.

Limites

Arquivos de até 60 MB por requisição. A análise em lote aceita até 100 itens por chamada.

Chamadas pelo navegador

O CORS está aberto, então páginas web podem chamar a API diretamente. Nunca inclua uma chave secreta no código front-end: faça as chamadas pelo seu próprio servidor.