락앤락몰의 데이터를 연동하기 위해 API에 대해 설명 합니다.
API 사용시 사전협의가 필요 합니다.
락앤락몰 API를 사용 하기 위해서는 API 인증키를 받아야 합니다.
사전에 인증키를 락앤락 담당자에게 키를 발급받으시고 관리에 유의하시기 바랍니다.
락앤락몰 API를 사용하기 위해서는 사용하실 웹서버의 IP를 담당자에게 사전 등록 해야 합니다.
락앤락몰 API는 웹을 통해 통신하며, 보안프로토콜을 사용합니다.
(반드시 https를 통해 요청 해야 합니다.)
요청시 필수 값은 Post 방식으로 전송 해야 합니다.
반환 데이터는 json으로 전송 됩니다.
발급 받은 API KEY를 통해 락앤락몰과 통신을 합니다.
데이터는 json으로 반환되며 데이터 형태는 사전에 협의가 필요 합니다. (인터페이스 정의서 작성)
락앤락몰 API의 각 기능별 요청 URL, 필수값, 반환값, 오류코드 등은 별도 전달해 드립니다.
API KEY를 헤더에 담아 아래 파라미터의 값들과 함께 POST로 요청합니다.
POST /api/sample HTTP/1.1
Host: api.locknlockmall.com
Authorization: {API KEY}
Content-type: application/x-www-form-urlencoded;charset=utf-8
요청시 필수값은 따로 전달해 드립니다.
주문 정보 조회 하고 싶다면 다음과 같이 요청 합니다. (예시 화면입니다.)
curl -v -X POST 'https://api.locknlockmall.com/api/order/order_list' \
-H 'Authorization: {API KEY}' \
--data-urlencode 'phone_number=010-1234-1234' \
--data-urlencode 'user_name=락앤락' \
--data-urlencode 'user_no=0000' \
요청이 성공하면 응답 바디에 JSON 객체로 다음과 같은 형태로 응답합니다.
HTTP/1.1 200 OK
Content-type: application/json;charset=utf-8
{
"state": "100"
,"message": "정상"
,"data": {...}
}
키 | 설명 | 필수 | 타입 |
---|---|---|---|
state | 상태 코드 | O | Integer |
message | 상태 메세지 | O | String |
data | 사전 협의에 의해 전달되는 데이터. | X | JSON Array 형태 |
문의 사항은 메일로 연락 바랍니다. ( 하재엽 과장 - jyha@locknlock.com )
감사합니다.