CATCH LOC Developers

[그룹관리] 그룹생성 API

Description

위치오브젝트의 그룹을 지정하고 생성하는 API.

API

api_code : api.common.group.set.add

HOST : http://cms.catchloc.com/api.partner.common.php

Method : GET

Protocol : JSON

Parameters

api : api_code
api_key : 고객사 파트너 키
timestamp : Unix timestamp
cert_key : 인증키
group_name : 그룹이름, URL ENCODE

Response

result : RESULT
group_key : 생성된 그룹의 그룹 키
message : result code

Example


            ===== Request =====

            http://cms.catchloc.com/api.partner.common.php?
            api=api.common.group.set.add&api_key=xxxxx&
            timestamp=1513319595&
            cert_key=xxxxx&
            group_name=%ED%85%8C%EC%8A%A4%ED%8A%B8+%EA%B7%B8%EB%A3%B9%EC%9D%B4%EB%A6%84



            ===== Response =====

            - 성공 시            
            {
              "result":"OK",
              "group_key" : "*******************",
              "message":"SUCCESS : GROUP_CREATE"
            }

            - 실패 시
            {
                "result":"FAIL",
                "message":"에러 사유"
            }


            ===== Request =====

            String group_name = "그룹 이름";

            CatchLoc catchloc = new CatchLoc();

            catchloc.setApiKey("API키");
            catchloc.setServerKey("서버키");

            JSONObject result = catchloc.createGroup(group_name);



            ===== Response (JSONObject) =====

            {
                "result"  : "ok",
                "type"    : "jsonobject"
                "message" : API Response Body
            }


            ===== Request =====

            import CatchLocSDKForAPI (공통)

            CatchLocAPI.shared.setApiKey(API_KEY)
            CatchLocAPI.shared.setserverKey(SERVER_KEY)

            -GROUP_NAME : 그룹이름, URL ENCODE

            CatchLocAPI.shared.createGroup(groupName: GROUP_NAME)
            { result in
                
                let jsonData = result.response

                혹은

                let jsonString = result.description()
            }

            ===== Response =====

            {
                "response" : API Response Body
            }


            ===== Request =====

            $group_name = '그룹 이름';

            $catchloc = new CatchLoc();

            $catchloc->setApiKey("API키");
            $catchloc->setServerKey("서버키")

            $result = $catchloc->createGroup($group_name);


            ===== Response (JSON 형태의 문자열) =====

            "{
                "result"  : "ok",
                "type"    : "map"
                "message" : API Response Body
            }"


            ===== Request =====

            var callback = function(json)
            {
                api 응답값을 처리하는 콜백함수의 내용
                (예시 : 지도에 위치 출력 혹은 목록 출력)
            };

            var params =
            {
                group_name: '그룹 이름',
            };

            CatchLoc.setApiKey("API키");
            CatchLoc.setServerKey("서버키");

            CatchLoc.createGroup(params, callback);



            ===== Response (JSON, callback 함수의 매개변수 내용) =====

            {
                "result"  : "ok",
                "type"    : "json"
                "message" : API Response Body
            }