개발가이드  >  기본사항

기본사항

API 통신 기준

1. 모든 요청(Request) 및 응답(Response)은 JSON 형식을 사용합니다.

2. 모든 데이터는 UTF-8 인코딩을 기준으로 처리됩니다.

3. API 호출 시 인증키(SBKEY)를 Header에 포함해야 합니다.

1. 서버 정보

운영 환경
환경 API URL
TEST API 테스트 서버 https://dev.sendbill.co.kr:444/{API_URL}
PROD API 운영 서버 https://api.sendbill.co.kr/{API_URL}

2. Request

API 요청 규칙
HTTP Method POST REST API 요청 방식
Content-Type application/json;charset=UTF-8
Accept-Charset UTF-8
Request 예시
HTTP Request
POST https://api.sendbill.co.kr/{API_URL}

SBKEY: xxxxxxxxxxxxxxxxxxxxxxxxx
Content-Type: application/json;charset=UTF-8
Accept-Charset: UTF-8			

Body
{
    "venderno" : "1234567890"
}

3. Response

API 응답 규칙
{ } 응답 형식 JSON
Aa 인코딩 UTF-8
✓ 결과코드 Result API 호출 결과를 나타내는 코드
! 결과메시지 Message API 처리 결과 메시지
Response 예시
{
    "Result" : 1,
    "Message" : "성공"
}

4. 인증키(SBKEY)

인증 정보

1. 모든 API 호출 시 Header에 SBKEY를 포함해야 합니다.

2. SBKEY는 센드빌 관리자에게 요청하여 발급받을 수 있습니다.

3. 유효하지 않은 인증키 사용 시 API 호출이 거부됩니다.

4. 인증키는 외부에 노출되지 않도록 안전하게 관리해야 합니다.

에러 처리

1. API 호출 실패 시 code와 message를 통해 오류 내용을 확인할 수 있습니다.

2. 상세 오류 목록은 오류코드 문서를 참고하시기 바랍니다.