Skip to main content

Protocol22-API 사용 함수 목록

 Javascript

JavaScript에서 API를 호출할 때는 ownerApp() 함수를 사용할 수 있습니다. ajax를 사용하여 API 요청을 보낼 때 사용됩니다.

$.fn.ownerKeyLinker.ownerApp = function (url, request, callback, async = true) {
    getParameter();

    $.ajax({
        // ${$.fn.ownerKeyLinker.serverUrl} : script 파라미터 url에 입력한 serverUrl
        url: `${$.fn.ownerKeyLinker.serverUrl}/dabory-app/${url}`, //ex. https://www.daborysso.com/dabory-app/auth/signup
        data: JSON.stringify(request),
        beforeSend: function (xhr) {
            xhr.setRequestHeader('OwnerKey', $.fn.ownerKeyLinker.ownerKey);
        },
        method: 'POST',
        dataType: 'json',
        async: async,
    })
    .done(function (json) {
        callback(json);
    })
    .fail(function (json, textStatus, errorThrown) {
        callback(json);
        iziToast.error({ title: 'Error', message: 'Dabory Owner App Error' });
    });
};

url : main app의 도메인/dabory-app/api url ( ex. www.daborysso.com/dabory-app/auth/signup)

request : 서버로 전송할 요청데이터 (JSON형식)

callback : 응답을 처리할 콜백함수

async : 요청의 동기/비동기 여부 (기본값 true -> 비동기 요청)

beforeSend: 요청 이전에 setRequestHeader를 통해 OwnerKey를 header에 넣음.

JavaScript에서 API를 호출할 때는 ownerApi() 함수를 사용할 수 있습니다. ajax를 사용하여 API 요청을 보낼 때 사용됩니다.

$.fn.ownerKeyLinker.ownerApi = function (url, request, callback, async = true) {
    getParameter(); // $.fn.ownerKeyLinker.serverUrl과 $.fn.ownerKeyLinker.ownerKey를 추출하는 함수

    $.ajax({
        url: `${$.fn.ownerKeyLinker.serverUrl}/dabory-app/call-owner-api`,
        data: JSON.stringify(request),
        beforeSend: function (xhr) {
            xhr.setRequestHeader('OwnerKey', $.fn.ownerKeyLinker.ownerKey);
            xhr.setRequestHeader('Url', url);
        },
        method: 'POST',
        dataType: 'json',
        async: async,
    })
    .done(function (json) {
        callback(json);
    })
    .fail(function (json, textStatus, errorThrown) {
        callback(json);
        iziToast.error({ title: 'Error', message: 'Dabory Owner API Error' });
    });
};

url : main app의 도메인/dabory-app/call-owner-api ( ex. www.daborysso.com/dabory-app/call-owner-api)

request : 서버로 전송할 요청데이터 (JSON형식)

callback : 응답을 처리할 콜백함수

async : 요청의 동기/비동기 여부 (기본값 true -> 비동기 요청)

beforeSend: 요청 이전에 setRequestHeader를 통해 OwnerKey와 url을 header에 넣습니다.

 OwnerApi vs OwnerApp

두 함수는 모두 다보리 API와 통신하는 역할을 하지만 요청을 처리하는 방식과 목적이 다릅니다. 

두 함수에서 호출할 수 있는 API 목록은 링크를 참고해주시기 바랍니다.

OwnerApp :

함수의 이름에서 알 수 있듯이 Js를 통한 APP과 APP간의 통신입니다. 예를들어 게스트 앱에서 메인 앱의 휴대폰 인증코드나 이메일 인증코드 발송 API를 호출하여 게스트 앱에서 해당 인증코드를 활용할 때 사용할 수 있습니다.

OwnerApi : 

게스트앱에서 메인앱의 API를 호출하여 필요한 데이터를 반환받을 때 활용할 수 있습니다. 예를들면 메인앱에 저장된 비밀번호 정책이나 가입한 회원 목록, 메인앱으로 회원가입 하기, 메인앱에서 회원 중복체크 등등 DB와 직접적으로 연동된 API를 호출할 수 있습니다.

No Comments
Back to top