시작하기
요청 및 오류
모든 Bitaloka 엔드포인트가 입력을 받고 결과를 반환하는 방식입니다. 한 번 익히면 어디에서나 사용할 수 있습니다.
기본 URL
https://api.bitaloka.io/v1 모든 엔드포인트는 /v1 아래에서 버전이 관리되며 HTTPS로만 제공됩니다.
입력 전송
- 경로 — 식별자를 URL에 직접 넣습니다. 예:
GET /v1/nik/{nik}. - JSON 본문 — 텍스트 서비스는
Content-Type: application/json을 받습니다. - 멀티파트 폼 — PDF 및 이미지 도구는
file(또는 여러 개의files)과 텍스트 필드 형태의 옵션을 포함한multipart/form-data를 받습니다.
반환되는 내용
파서, 조회, AI는 JSON을 반환합니다. PDF 도구는 처리된 파일(application/pdf, 분할의 경우 application/zip)을 반환하므로 본문을 그대로 디스크에 저장하세요.
유효하지 않은 입력은 오류가 아닙니다
형식이 잘못된 NIK도 HTTP 200을 반환하며, valid: false와 그 이유를 설명하는 errors 목록이 포함됩니다. 상태 코드가 아닌 valid를 기준으로 분기하세요.
{
"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": []
} 오류
실제 오류에는 표준 HTTP 상태 코드와 JSON 본문 {"error": "…"}이 사용됩니다.
| 상태 | 의미 |
|---|---|
400 | 입력이 누락되었거나 형식이 잘못되었습니다. 예: 파일이 없거나 페이지 범위가 유효하지 않음. |
401 | API 키가 없거나 인식되지 않습니다(키가 필수가 된 이후). |
413 | 업로드 크기가 60 MB를 초과합니다. |
503 | 종속 서비스를 일시적으로 사용할 수 없습니다. 지수 백오프로 재시도하세요. |
제한
업로드는 요청당 최대 60 MB입니다. 일괄 파싱은 호출당 최대 100개 항목을 처리합니다.
브라우저에서 호출하기
CORS가 허용되어 있어 웹 페이지에서 API를 직접 호출할 수 있습니다. 비밀 키를 프런트엔드 코드에 포함하지 말고, 자체 서버를 통해 호출하세요.