Vai al contenuto
Bitaloka Docs
Richieste ed errori

Per iniziare

Richieste ed errori

Come ogni endpoint Bitaloka riceve input e restituisce risultati — impara una volta, usalo ovunque.

URL di base

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

Tutti gli endpoint sono versionati sotto /v1 e serviti solo tramite HTTPS.

Invio dell’input

  • Percorso — gli identificativi vanno direttamente nell’URL, ad es. GET /v1/nik/{nik}.
  • Body JSON — i servizi di testo accettano Content-Type: application/json.
  • Form multipart — gli strumenti per PDF e immagini accettano multipart/form-data con file (o più files) e le opzioni come campi di testo.

Cosa viene restituito

Parser, lookup e AI restituiscono JSON. Gli strumenti PDF restituiscono il file elaborato (application/pdf, o application/zip per la divisione) — scrivi il body direttamente su disco.

Un input non valido non è un errore

Anche un NIK malformato riceve HTTP 200, con valid: false e una lista errors che ne spiega il motivo. Basa la logica su valid, non sul codice di stato.

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": []
}

Errori

Gli errori veri e propri usano i codici di stato HTTP standard e un body JSON {"error": "…"}.

StatoSignificato
400Input mancante o malformato — ad es. nessun file o un intervallo di pagine non valido.
401Chiave API mancante o non riconosciuta (quando le chiavi saranno obbligatorie).
413Upload superiore a 60 MB.
503Una dipendenza è temporaneamente non disponibile. Riprova con backoff esponenziale.

Limiti

Upload fino a 60 MB per richiesta. Il parsing in batch accetta fino a 100 elementi per chiamata.

Chiamate dal browser

CORS è aperto, quindi le pagine web possono chiamare l’API direttamente. Non includere mai una chiave segreta nel codice front-end — passa invece dal tuo server.