API 개발자 문서
Rest API를 사용하기 위해 먼저 API Key 와 Secret Key를 발급 받아야 합니다. 해당 키는 사이트 단위로 생성되기 때문에 여러 사이트를 운영한다면 구분하여 사용해 주시기 바랍니다.
전체 조회 API(상품 조회, 주문 조회, 회원 조회 등)은 최대 초당 1회, 그 외 API는 최대 초당 5회 호출 가능합니다.
필요한 데이터만 조회하세요.
GET
https://api.imweb.me/v2/shop/products/{상품번호}
Parameters
Query
key :  string ( API Key )
secret :  string ( Secret Key )
Header
ACCESS_AFFILATE :  string ( 제휴사 업체 코드)
제휴사의 경우에만 입력합니다.
제휴사 코드는 담당자에게 문의바랍니다.
Responses
200
{"msg":"SUCCESS","code":200,"access_token":"{ACCESS_TOKEN}"}
GET
https://api.imweb.me/v2/shop/products/{상품번호}
상품번호를 입력하지 않으면 전체 상품 목록을 조회합니다.
PATCH
https://api.imweb.me/v2/shop/products/{상품번호}
수정 시 변경할 항목만 전달해주세요.
DELETE
https://api.imweb.me/v2/shop/products/{상품번호}
POST
https://api.imweb.me/v2/shop/inquirys/{문의번호}
최대 API 호출 횟수를 초과하는 경우 비정상적인 접속이나 공격으로 간주하여, API 호출이 차단당할 수 있으니 유의하시기 바랍니다.
Zgai의 RestAPI는 개발이 계속 진행되고 있습니다. 따라서, 문서의 내용은 언제든지 변경될 수 있습니다.
키 발급방법
1.
아직 아임웹에서 사이트를 개설하지 않으셨다면 사이트를 개설합니다.
2.
내 사이트 > 에서 관리 버튼을 눌러 사이트 관리페이지로 이동합니다.
3.
환경설정 > 외부 서비스 연동 (API)으로 이동합니다.
4.
API key 발급받기 버튼을 누릅니다.
요청 데이터
항목
version
타입
string
설명
요청 Rest API 버전
가장 최신 버전을 사용하시려면 공백 또는 latest로 전달해주세요.
필요한 데이터만 조회하세요.
필요한 데이터만 조회하세요.
필요한 데이터만 조회하세요.
항목
version
타입
string
설명
요청 Rest API 버전
가장 최신 버전을 사용하시려면 공백 또는 latest로 전달해주세요.
항목
version
타입
string
설명
요청 Rest API 버전
가장 최신 버전을 사용하시려면 공백 또는 latest로 전달해주세요.
API 오류 코드
코드
-1
설명
잘못된 API 키 또는 시크릿
코드
-6
설명
이용 버전 권한 오류 ( 보통 버전별 제한에 걸릴 때 발생 )
코드
-10
설명
잘못된 파라미터 또는 호출 인자가 잘못되었거나 필수 인자가 포함되지 않은 경우
코드 작성 영역
CURL
curl -X GET -H "Content-Type: application/json" -H "access-token: {ACCESS_TOKEN}" -d '{"version":"latest"}' https://api.imweb.me/v2/shop/products
PHP
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.imweb.me/v2/shop/products');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1) ;
curl_setopt($ch, CURLOPT_HTTPHEADER, ['access-token: {ACCESS_TOKEN}']);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(['version' => 'latest']));
$res = curl_exec($ch);
curl_close($ch);
Array
(
    [msg] => SUCCESS
    [code] => 200
    [request_count] => 4
    [version] => 2.0
    [data] => Array
        (
            [list] => Array
                (
                    [0] => Array
                        (
                            [no] => 13805
                            [categories] => Array
                                (
                                    [0] => s201801045a4dc150f0580
                                )

                            [custom_prod_code] => 13805
                            [name] => Rest API 이미지 업로드 테스트
                            [content] => 상품설명
                            [content_plain] => 상품설명
...