시작하기

도매꾹 가입 및 아이디 생성

도매꾹 API 사용을 위해서는 먼저 이용하시려는 기업·사업자·개인은 최소 1개의 도매꾹 아이디를 생성해야 합니다. 일부 API의 경우에는 사업자만 사용이 가능하므로, 가급적 사업자 등록이 되어 있는 사용자는 사업자인증을 통해 사업자 회원으로 전환하시기 바랍니다.

도매꾹과 도매매는 아이디를 공유합니다. 그러므로 위 과정은 도매꾹 또는 도매매 어느 한 쪽과 연동을 진행할 때에나 양쪽 모두와 연동을 진행할 때에 모두 동일합니다.

API Key 발급받기

생성한 아이디로 먼저 도매꾹에 로그인 한 후, API Key를 발급받아 주십시오. API Key는 API 키 관리에서 발급받을 수 있습니다. 발급받은 API Key는 모든 API 통신에서 반드시 파라미터로 입력되어 있어야 합니다. 아이디 1개당 최대 5개의 키를 API Key받을 수 있습니다.

API 사용하기

이제 API를 HTTPS 통신을 통해 사용할 수 있습니다. 가장 먼저 모든 사용자가 이용할 수 있는 Open API 중에서 원하는 API를 선택하여 레퍼런스를 확인하고 통신해보는 것을 권장합니다. 더 빠르게 시작하고자 한다면, 예제코드에서 자신이 선택한 개발언어의 예제를 확인하고 활용할 수도 있습니다. 발급받은 API Key를 요청 파라미터로 입력하는 것을 잊지 마세요.

오류메시지 다루기

도매꾹 Open API는 오류가 발생할 경우, API의 종류에 관계없이 항상 동일한 형식의 표준오류 메시지를 반환합니다. 따라서 각 API 사용자는 사용하는 API의 종류에 관계없이 하나의 로직으로 오류메시지를 해석할 수 있습니다. 표준오류 메시지의 형식과 해석에 관해서는 표준오류 메시지 안내를 확인하십시오.

주의사항

  • 글자수레퍼런스에서 언급하는 글자수는 byte수가 아닌 순수 글자 개수를 의미합니다. 따라서 한글과 영문, 특수문자의 각 문자는 그 인코딩을 불문하고 1글자로 취급합니다.
  • 인코딩본 API 호출시에 파라미터에 입력하는 모든 문자열은 EUC-KR 인코딩에서 지원하는 문자로 이루어져야 합니다. 이것은 UTF-8 인코딩으로 통신을 할 때에도 마찬가지입니다. EUC-KR에 포함되지 않는 한글, 다국어 문자 등을 입력할 경우, API가 오작동하거나 오류 메시지를 출력할 수 있습니다.
  • 프로토콜별도의 기재가 없는 이상, 모든 API는 HTTP 통신을 통해 사용할 수 있으나, RESTful API의 형태를 따르고 있지는 않습니다. 통신이 정상적으로 이루어졌다면 HTTP Response Code는 오류/정상작동 여부에 관계 없이 200입니다.
  • 보안경고로그인이 필요한 API의 경우, 사용 중에는 반드시 id와 sId가 유출되지 않도록 유의하시고, 사용 후에는 로그아웃 API를 통해 꼭 로그아웃을 하시기 바랍니다. 두 값을 탈취한 제3자는 원사용자가 아님에도 로그인이 된 상태처럼 API를 이용할 수 있으며, 도매꾹은 이러한 상황에서 해당 접근이 정상적인 접근인지 유출정보를 통한 어뷰징인지 구분할 수 없습니다.
  • 최대접속제한Open API를 비롯하여 도매꾹 웹서버에는 최대접속 허용량이 정해져 있습니다. 최대접속 허용량은 분당 180회, 하루 15,000회입니다. 이 허용량을 넘어서는 경우에는 접속을 자동차단하여 HTTP Response Code 429를 반환합니다. 분당 180회 이상 접속한 경우 차단 후 3분, 하루 15,000회 이상 접속한 경우 당일 자정까지 API를 사용할 수 없습니다. 다만 허용량을 하회하는 경우에도 정상적인 서비스 운영을 어렵게하는 접속은, 접속패턴이나 접속시도를 얼마나 오래 지속하는지 여부를 판단하여 차단할 수 있습니다.