Zum Inhalt springen
Bitaloka Docs
Anfragen & Fehler

Erste Schritte

Anfragen & Fehler

Wie jeder Bitaloka-Endpoint Eingaben entgegennimmt und Ergebnisse meldet – einmal lernen, überall nutzen.

Base-URL

Base-URL
https://api.bitaloka.io/v1

Alle Endpoints sind unter /v1 versioniert und nur über HTTPS erreichbar.

Eingaben senden

  • Pfad – Kennungen kommen direkt in die URL, z. B. GET /v1/nik/{nik}.
  • JSON-Body – Textdienste erwarten Content-Type: application/json.
  • Multipart-Formular – PDF- und Bild-Tools erwarten multipart/form-data mit file (oder mehreren files) plus Optionen als Textfelder.

Was zurückkommt

Parser, Lookups und KI liefern JSON. PDF-Tools liefern die verarbeitete Datei (application/pdf bzw. application/zip beim Aufteilen) – schreib den Body direkt auf die Festplatte.

Ungültige Eingabe ist kein Fehler

Auch eine fehlerhafte NIK erhält HTTP 200, mit valid: false und einer errors-Liste, die den Grund erklärt. Verzweige anhand von valid, nicht anhand des Statuscodes.

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

Fehler

Echte Fehler verwenden Standard-HTTP-Statuscodes und einen JSON-Body {"error": "…"}.

StatusBedeutung
400Fehlende oder fehlerhafte Eingabe – z. B. keine Datei oder ein ungültiger Seitenbereich.
401API-Key fehlt oder wird nicht erkannt (sobald Keys erforderlich sind).
413Upload größer als 60 MB.
503Eine Abhängigkeit ist kurzzeitig nicht verfügbar. Versuch es mit exponentiellem Backoff erneut.

Limits

Uploads bis 60 MB pro Anfrage. Batch-Parsing verarbeitet bis zu 100 Einträge pro Aufruf.

Aufrufe aus dem Browser

CORS ist offen, Webseiten können die API also direkt aufrufen. Liefere niemals einen geheimen Key im Frontend-Code aus – ruf die API stattdessen über deinen eigenen Server auf.