본문으로 건너뛰기

API 사용 가이드

API 서버 정보​

  • Endpoint: https://openapi.willog.io
  1. api endpoint: /ext/*
  2. api endpoint: /hub/*

1번 과 2번은 서로 다른 서비스이므로 인증방식이 상이할 수 있습니다.
안내 받은 인증방식을 참고하여 요청해주시기 바랍니다.

인증 방식​

1. API KEY 방식​

  • 모든 API는 당사가 제공한 ApiKey 값을 Request Header에 포함하여 요청해야 합니다.
  • Header의 Authorization: Bearer <API KEY>: 
    {
      "Authorization": "Bearer <api-key>"
    }
  • API Key는 고객사별로 전달될 예정입니다.

2. AccessToken 방식​

  • 인증 후 AccessToken을 발급받아 사용합니다.
  • Header의 Authorization: Bearer <accessToken> 
    {
      "Authorization": "Bearer <AccessToken>"
    }
  • 모든 API는 인증 후 발급받은 AccessToken 값을 Request Header에 포함하여 요청해야 합니다.

공통 Error Response​

인증 실패​

HTTP/1.1 400 Bad Request

{
  "code": "A0010"
}

Bad Request Data​

HTTP/1.1 400 Bad Request

{
  "code": "E0021"
}

주의사항​

  1. API KEY 또는 발급받은 AccessToken으로 인증을 진행하면 됩니다.
  2. AccessToken 의 경우 만료기간이 있으니 주의해주시기 바랍니다.
  3. API KEY, AccessToken 을 안전하게 보관하여 사용해주시기 바랍니다.
  4. 공통 Error Response 이외에도 API별로 상세한 Error Response를 확인해주세요.