더망고 API 이용방법

개요

더망고 API는 더망고 솔루션을 이용하고 있는 이용자에게 더망고 솔루션의 일부 기능을 API로 제공하는 서비스입니다

API 규격

호출 도메인 주소 : https://{TheMangoClient}
{TheMangoClient} 는 더망고 솔루션 이용자의 서버 주소입니다. (ex. https://tmg9999.mycafe24.com)
Content-Type JSON 방식으로 호출합니다.

API Limit

더망고 API는 기본적으로 초당 3회 호출이 가능하고, 1초에 3회 호출을 초과하는 경우 429 에러(Too Many Requests)를 반환합니다.

더망고 API는 기본적으로 한번의 요청(Request)당 1개의 Token이 차감됩니다.
(단, 일부 API는 한번의 요청(Request)에 2개 이상의 Token이 차감될 수 있으니, 자세한 부분은 해당 API 명세서를 참고해주시기 바랍니다.)

기본적으로 일일 최대 10,000 Token / 월 최대 100,000 Token 이용이 가능합니다. 최대 Token 수는 요금제에 따라 달라질 수 있습니다.
최대 Token 수를 초과하는 경우 429 에러(Daily/Monthly Token Limit Exceeded)를 반환합니다.
(단, API 의 종류에 따라 Token 수의 제한 조건이 다를 수 있으니, 자세한 부분은 해당 API 명세서를 참고해주시기 바랍니다.)

API Key 발급

더망고 API Key는 두 가지 방식(더망고 API, 더망고 확장프로그램 App)으로 이용 가능합니다.

1. 더망고 API를 이용하는 경우, 솔루션 관리자페이지 [환경설정] - [서비스정보] 메뉴에서 API Key 를 발급받을 수 있습니다.
2. 더망고 비즈센터 확장프로그램을 이용하는 경우, 더망고 비즈센터의 [APP 센터] - [확장프로그램]에서 APP을 이용신청하시면 자동으로 발급되며,
발급된 API Key는 솔루션 관리자페이지 [환경설정] - [더망고 확장프로그램 앱] 메뉴에서 확장프로그램 앱 API Key 확인이 가능합니다.
3. 더망고 확장프로그램 앱 개발자용 API Key는 더망고 비즈센터에서 개발자 등록 후 [판매관리]-[확장프로그램관리]-[Test API Key 관리] 메뉴을 통해 발급이 가능합니다.

Request Header의 구성

X-API-SENDER 헤더에는 본인이 개발중인 프로그램명을 영문으로 입력해주시면 됩니다. 필수 헤더 값입니다.
Authorization 헤더에는 발급받으신 API Key를 "Bearer {API Key}" 형태로 입력해주시면 됩니다. 필수 헤더 값입니다.

"Authorization" : "Bearer {API Key}"
"X-API-SENDER" : "개발프로그램명(영문)"
"Content-Type" : "application/json"

cURL 예제

각 API 별로 각 cURL 호출 방식을 확인할 수 있습니다.

curl --location 'https://tmg9999.mycafe24.com/api/imagesList' \
--header 'Authorization: Bearer xxxxxxxxxxxxxxx' \      // 발급받은 api 키
--header 'Content-Type: application/json' \
--data '{
    "productId": "1000000",
    "imageType": "representative" // representative : 대표이미지, detail : 상세페이지 이미지
}'

Response Header의 구성

API 응답으로 API Token 잔량에 대한 응답헤더를 제공합니다.

"X-RateLimit-Daily-Remaining" : "오늘 남은 API Token 개수"
"X-RateLimit-Monthly-Remaining" : "이번달 남은 API Token 개수"
"X-RateLimit-{API종류}-Daily-Remaining" : "요청한 API 가 별도 일 기준 Limit Token 개수가 있는 경우, 요청한 API 대한 오늘 남은 API Token 개수"
"X-RateLimit-{API종류}-Monthly-Remaining" : "요청한 API 가 별도 월 기준 Limit Token 개수가 있는 경우, 요청한 API 대한 이번달 남은 API Token 개수"

성공메세지

API 통신 성공시에는 200 코드가 리턴되며, 포멧은 아래와 같습니다. 출력데이터가 있는 경우 data 안에 출력데이터가 제공됩니다.

{
    "code": "200",
    "timestamp": "2024-12-23 13:01:03",
    "requestId": "173493342849360",
    "data": {
        .............. // API 성공시 제공해주는 Data
    }
}

오류메세지

API 통신 오류 발생 시에는 다음과 같은 항목이 출력됩니다.

{
    "code": 400,
    "message": "WRONG IMAGETYPE [REPRESENTATIVE / DETAIL]",
    "timestamp": "2025-06-24 17:37:05",
    "requestId": "175075422558035"
}
  • code : API 결과 코드
  • message : API 오류 메세지 (구체적인 오류 메세지가 표기됩니다.)
  • timestamp : 타임스탬프
  • requestId : API 요청마다 생성되는 고유한 ID

API 결과 코드

200 성공
400 API 필수 정보 누락 및 잘못된 파라미터가 전송되었습니다.
401 API Key 인증이 실패되었습니다.
403 API 사용 권한이 없습니다.
404 찾을 수 없는 페이지입니다.
429 API 요청이 허용된 요청량을 초과하였습니다.
500 그외 기타 오류

API 공통 에러 메세지

WRONG BEARER TOKEN API Key 정보가 잘못되었습니다.
NO X-API-SENDER HEADER API 요청헤더에 X-API-SENDER 헤더값이 누락되었습니다.
NO PARAMETER Request 파라미터가 전송되지 않았습니다.
MISSING PARAMETER(S) XXXX XXXX 파라미터가 누락되었습니다.
MAXIMUM XXXX : NN XXXX 파라미터는 최대 Array 개수를 NN개까지 입력이 가능합니다.
WRONG XXXX [ 1 / 2 / 3 ] XXXX 파라미터는 1, 2, 3 값만 전송이 가능합니다.
PARAMETER MUST BE NUMERIC : XXX XXXX 파라미터는 숫자만 전송 가능합니다.
PERMISSION DENIED 접속하실 권한이 없는 API 입니다.
API KEY EXPIRED 유효기간이 만료된 API Key 입니다.
TOO MANY REQUESTS 허용된 API Limit 을 초과하였습니다.
DAILY TOKEN LIMIT EXCEEDED 일일 호출 Token 한도를 초과하였습니다. 다음 날 00시 이후에 다시 이용해주세요.
MONTHLY TOKEN LIMIT EXCEEDED 월간 호출 Token 한도를 초과하였습니다. 다음 달 1일 이후에 다시 이용해주세요.