API
요청 & 응답
incento Open API의 인증 헤더, 공통 응답 구조, 에러 형식을 안내합니다.
베이스 URL
https://api.incento.kr/api/open모든 엔드포인트는 이 베이스 URL을 기준으로 합니다.
예: POST https://api.incento.kr/api/open/orders/sync/
인증
모든 요청에 X-Incento-Key 헤더로 시크릿 키를 전달해야 합니다.
X-Incento-Key: inc_sk_YOUR_SECRET_KEYAPI 키 발급은 API 키를 참고하세요.
응답 형식
성공
모든 성공 응답은 data 키로 페이로드를 감쌉니다.
{
"data": {
"accepted_count": 3
}
}에러
모든 에러 응답은 error 키로 일관된 형식을 반환합니다.
{
"error": {
"type": "validation_error",
"code": "invalid_request",
"message": "At least one order is required.",
"params": {
"orders": ["At least one order is required."]
}
}
}| 필드 | 설명 |
|---|---|
type | 에러 분류의 큰 카테고리 (authentication_error, permission_error, validation_error, api_error) |
code | 코드 기반의 구체적인 세부 에러 식별자 — 분기 처리 시 이 값을 사용하세요 |
message | 에러 설명 문구 — 사전 예고 없이 변경될 수 있습니다 |
params | 필드별 검증 에러 목록 (validation_error 타입에서만 포함) |
주요 에러 코드
| HTTP | type | code | 원인 |
|---|---|---|---|
| 401 | authentication_error | invalid_api_key | Key 없음 또는 유효하지 않은 Key |
| 401 | authentication_error | secret_key_required | Public Key로 서버 전용 엔드포인트 호출 |
| 400 | validation_error | invalid_request | 요청 바디 검증 실패 |
| 503 | api_error | service_unavailable | 내부 서비스 일시 장애 — 재시도하세요 |