Protocol22-API

개요
Protocol22-API 목록
Protocol22-API 사용 함수 목록
[JavaScript] Protocal22-API 사용예제
[WebApp] Protocal22-API 사용예제 (PHP)
[WebApp] Protocal22-API 사용예제 (GoLang)
OwnerKey를 활용한 게시판 연동 예제

개요

PROTOCOL22-API

PROTOCL22는 다보리SSO에서 OwnerKey를 활용하여 MAIN APP과 GUEST APP간의 API를 공유하여 특정 API에 접근하는 방식입니다.

OwnerKey란?

PROTOCAL22-API를 사용하기 위해서는 OwnerKey 발급이 필요합니다.

여기서 OwnerKey는 APP 등록시 main APP에 등록된 API 서버와 DB 접근 권한이 설정된 암호화 KEY입니다.

발급된 OwnerKey를 guest APP에 저장하여 PROTOCL22-API를 사용할 수 있습니다.

OwnerKey 발급방법

1. main app을 등록한 dabory 계정으로 로그인합니다.

2. guest app 등록을 위해서 My App 메뉴를 클릭합니다.

3. 좌측 메뉴에서 App Manager를 클릭합니다.

4. 등록한 app중 Owner key를 공유할 app을 클릭합니다.

5. GuestApp 탭을 클릭합니다.

6. a부터 c까지 입력 및 선택합니다.

ⓐ Guest App Name : Owner Key의 이름

ⓑ OwnerCode : Owner Key의 제한방식

owner : 모든 api 허용
keypair :
dbupdate :
limited : 일부 api만 허용

7. Download .owner-key 버튼을 클릭하여 Owner key를 download 합니다.

8. MainApp 탭을 누른뒤 save 버튼을눌러 저장합니다.

9. 생성된 .owner-key를 확인하고 frontend 소스코드를 open합니다.

10. .env 파일에 MAIN_API_OWNER_KEY 변수를 추가하고 생성된 owner key의 값을 넣어줍니다.

Protocol22-API 종류

1. Javascript (js 방식)

2. GO (webapp 방식)

3. Laravel (webapp 방식)

js방식과 app방식의 차이점

구분	Javascript	WebApp
호출	프론트엔드(브라우저)	백엔드(Laravel, Go)
목적	Guest APP에서 직접 API 요청	서버간 api 요청 (Backend to Backend)
호출방식	$.fn.ownerKeyLinker.ownerApp() 호출	callOwnerApi() 호출
OwnerKey 저장	스크립트에 직접입력	특정 변수에 저장후 session 활용
인증방식	OnwerKey를 직접 포함하여 API 요청	GateToken을 세션에서 불러와 API 요청
보안	상대적으로 낮음 (클라이언트에서 호출)	상대적으로 높음(서버에서 요청)
사용예제	<script> 태그로 js 라이브러리 로드후 호출	Laravel, Go 등의 서버 코드에서 API 호출

Protocol22-API 목록

Protocol22-API는 다양한 요청을 처리할 수 있는 API 목록을 제공합니다. 각 요청 URL과 메서드, 응답 형식, 그리고 그에 대한 설명을 아래에 정리하고, 각 요청에 대한 더 자세한 설명을 추가하겠습니다.

요청 URL	매서드	응답 형식	설명
/printing-curr-price	post	json
/printing-curr-price	post	json
/projects	get	json
/projects	post	json
/projects	post	json
/projects/{id}	get	json
/projects	delete	json
/after-base64	post	json
/send-images	post	json
/text-send	post	json
/gate-token-get	post	json
/call-owner-api	post	json
/owner-token-get	post	json
/auth/send-emailConfirm	post	json
/auth/send-smsConfirm	post	json
/auth/signup	post	json
/item-url-scrap	post	json
/gate-token-get-test	post	json
/call-api	post	json
/send/text	post	json
/send-mail	post	json
/test-send-mail	post	json
/elasticsearch	post	json
/elasticsearch-dsl	post	json

Protocol22-API 사용 함수 목록

Javascript

1. ownerApp

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에 넣음.

2. ownerApi

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를 호출할 수 있습니다.

[JavaScript] Protocal22-API 사용예제

시작하기 전에

이 문서는 Dabory Protocol22-API for JavaScript를 사용하여 Main App과 Guest App을 개발할 때 필요한 참고 정보를 제공하며 JavaScript를 활용한 클라이언트 측 API 호출 방식을 설명합니다.

예제실행전에 아래 준비사항들을 반드시 준비해주시기 바랍니다.

script 다운로드
app 등록하기

JavaScript 방식의 API 호출 흐름

1. 클라이언트 측 JavaScript에서 OwnerKey 및 MAIN APP의 URL 정보를 설정합니다.

2. JavaScript에서 ownerApp() 함수를 사용하여 API 요청을 보냅니다.

3. API 응답을 받아 클라이언트 측에서 데이터를 처리합니다.

JavaScript 사용예제 (회원가입 구현)

script 선언과 변수설정

javascript 방식에서는 script src 속성의 파라미터 url로 ServerUrl과 OwnerKey를 직접 입력합니다.

<script src="/js/dabory.owner-key-linker.js?serverUrl=https://www.daborysso.com&ownerKey=zEUhgZEpPbFpz/cIghtYCsoFlNi8JX3Lh45ank1s+w2PGuK4phOxmemgKuuIJ/OQZlrpdSzlK03MpBLBSo1o537brbDPKaq9ydK8QK8JgEAYGKSNzD8W6dJhSIjPfxLJu+cma0wcAMDmSV7DMhwwgiwVb2ADWu+QOVKpU+VmIR1TBIfT00EPpuW1Ju+jop8WcBEJRrpEAGLK5jcRnAGSXaDTumqEVsLRSq87hVqRJGImIE7Bf68Ix4b2PqgVhTUY1Bpalw=="></script>

serverUrl : MAIN APP의 도메인주소를 입력합니다.

ownerKey : MAIN_APP 등록시 발급받은 OwnerKey를 입력합니다.

API 요청 함수(OwnerApp)

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 : API 요청의 엔드포인트( ex. www.daborysso.com/dabory-app/auth/signup)

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

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

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

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

API 요청 함수(OwnerApi)

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 : API 요청의 엔드포인트( ex. www.daborysso.com/dabory-app/call-owner-api)

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

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

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

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

OwnerApi 함수는 OwnerApp 함수와는 다르게 api 서버에 요청할 api url을 header에 넣습니다.

OwnerApi vs OwnerApp

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

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

OwnerApp()

OwnerApi()

차이점

게스트앱에서 메인앱에 구현된 백엔드 API를 호출할때 (메인앱의 백엔드에 로직 구현 필요)

게스트 앱에서 메인앱의 백엔드 API를 거쳐 api 서버에 구현된 api를 호출할 때 (api 서버에 구현된 로직을 호출)

호출 흐름

guest (frontend)-> main (backend) -> guest(frontend)

guest (frontend)-> main (backend) -> api 서버 (backend) -> guest(frontend)

ownerApi 호출 예제

- API를 호출하여 비밀번호 정책 (passwd-policy) 데이터를 가져오는 예제입니다.

$.fn.ownerKeyLinker.ownerApi(
    'remote-signup-setup-get',
    {
        'SetupCode': 'passwd-policy',
        'BrandCode': 'member'
    },
    function (response) {
        window.passwdPolicy = response;
        $('#policy-desc-em').text(window.passwdPolicy['PolicyDesc']);
        console.log(window.passwdPolicy);
        $('#join').modal('show');
    }
);

첫번째 인자값 : api 서버의 url

두번쨰 인자값 : api 서버 요청시 body에 포함될 request 객체

세번째 인자값 : response를 받아온뒤 실행될 callback 함수

ownerApp 호출 예제

- API를 호출하여 휴대폰 인증코드 (auth/send-smsConfirm)를 발송하는 예제입니다.

$.fn.ownerKeyLinker.ownerApp('auth/send-smsConfirm', {
    "MobileNo": $('#mobile-no-txt').val(),
}, function (response) {
    if (response['error']) {
        $($this).prop('disabled', false);
        SmsNumber = null;
        iziToast.error({ title: 'Error', message: response['message'] });
    } else {
        SmsNumber = response['data'];
        iziToast.success({ title: 'Success', message: '휴대전화 전송 성공' });
    }
});

- API를 호출하여 이메일 인증코드 (auth/send-emailConfirm)를 발송하는 예제입니다.

$.fn.ownerKeyLinker.ownerApp('auth/send-emailConfirm', {
    "Email": $('#email-txt').val(),
}, function (response) {
    if (response['error']) {
        $($this).prop('disabled', false);
        EmailNumber = null;
        iziToast.error({ title: 'Error', message: '인증메일 전송 에러' });
    } else {
        EmailNumber = response['data'];
        iziToast.success({ title: 'Success', message: '인증메일 전송 성공' });
    }
});

API를 호출하여 회원가입을 요청하는 예제입니다.

$.fn.ownerKeyLinker.ownerApp('auth/signup', {
    "Email": $('#email-txt').val(),
    "Password": $('#password-txt').val(),
    "MobileNo": $('#mobile-no-txt').val(),
    "FirstName": $('#first-name-txt').val(),
}, function (response) {
    if (response['error']) {
        if (response['code'] === 701) {
            iziToast.info({ 
                title: 'Info', 
                message: '해당 이메일은 이미 다보리 통합 회원가입이 완료되었습니다. 로그인 버튼을 눌러 바로 로그인해 주세요.' 
            });
        } else if (response['validator']) {
            showErrorMessages(response['message']);
        } else {
            iziToast.info({ title: 'Info', message: response['message'] });
        }
        click_submit_btn(self, false);
    } else {
        iziToast.success({ title: 'Success', message: $('#action-completed').text() });
        $('#join').modal('hide');
    }
});

첫번째 인자값 : main app의 백엔드 api의 url을 입력합니다.

두번쨰 인자값 : main app의 백엔드 api url입니다.

세번째 인자값 : response를 받아온뒤 실행될 callback 함수입니다.

response['error'] : api의 response status가 200이 아닐 경우 respons['error']이 반환됩니다.

[WebApp] Protocal22-API 사용예제 (PHP)

[WebApp] PROTOCOL22-API 사용예제

시작하기 전에

이 문서는 Dabory OwnerKey API for WebApp을 사용하여 Main App과 Guest App을 개발할 때 필요한 참고 정보를 제공하며
PHP Laravel을 활용한 WebApp 방식으로 PROTOCOLl22-API를 호출하는 방법을 설명합니다.

WebApp 방식의 Owner Key API 호출 흐름

1. .env 파일에 환경변수를 저장합니다.

2. Laravel callOwnerApi() 함수를 통해 Owner APP에 등록된 API 서버로 요청을 보냅니다.

3. 세션에 저장된 GateToken과 frontUrl 정보를 활용하여 API 요청을 보냅니다.

4. API 응답을 받아 데이터를 처리합니다.

WebApp 사용예제

- env 파일에 환경변수 저장

먼저 .env 파일에 OwnerKey 및 APP 정보를 설정해야합니다.

변수명은 다운로드 받은 그대로 동일하게 작성해야 하지만 설정할 MAIN APP이 2개 이상이라면

개수의 맞게 변수 끝에 _ 숫자를 입력하여 변수명을 네이밍합니다.

# [protocol22]
OWNER_APP_NAME=YOUR_OWNER_APP_NAME  # Owner APP의 이름 (자유롭게 지정)
GUEST_APP_OWNER_KEY=YOUR_OWNER_KEY  # Guest APP에서 발급받은 OwnerKey 입력
GUEST_APP_OWNER_URL=YOUR_OWNER_URL  # Owner APP의 URL 입력 (ex.www.daborysso.com)

OWNER_APP_NAME2=YOUR_OWNER_APP_NAME_2
GUEST_APP_OWNER_KEY2=YOUR_OWNER_KEY_2
GUEST_APP_OWNER_URL2=YOUR_OWNER_URL_2

OWNER_APP_NAME3=YOUR_OWNER_APP_NAME_3
GUEST_APP_OWNER_KEY3=YOUR_OWNER_KEY_3
GUEST_APP_OWNER_URL3=YOUR_OWNER_URL_3

💡 OwnerKey란?

OwnerKey는 GUSET APP이 MAIN APP의 API를 호출할 때 사용되는 고유한 인증 키입니다.
WebApp 방식에서는 OwnerKey를 .env 파일에 저장하고, API 요청 시 세션을 활용하여 사용합니다.

- Laravel에서 Owner API 호출

이제 callOwnerApi() 함수를 이용하여 MAIN APP의 API 서버에 요청을 보낼 수 있습니다.

public function callOwnerApi($request)
    {
        // 요청된 'type'에서 숫자를 추출 (guest[1] → 1)
        preg_match('/\d+/', $request['type'], $matches);
        $index = isset($matches[0]) ? (int) $matches[0] : null;

        // 세션에서 API URL 및 GateToken 조회
        if ($index !== null) {
            $apiUrl = session("OwnerGateToken.guest")[$index]['frontUrl'] ?? null;
            $gateToken = session("OwnerGateToken.guest")[$index]['gateToken'] ?? null;
        }

        // API 요청 URL 설정
        $request['url'] = $apiUrl . '/' .$request['url'];
        $request['headers'] = ['GateToken' => $gateToken];
        return $this->callApi($request);
    }

- API 호출 예제

API를 호출하여 remote-signup-setup-get api의 데이터를 가져오는 예제입니다.

$officeInfo = $this->callApiService->callOwnerApi([
    'url'  => 'remote-signup-setup-get', // api 서버에 요청할 api url
    'data' => [  // 요청할 data
        'SetupCode' => 'passwd-policy',
        'BrandCode' => 'member',
    ],
    'type' => 'guest[1]' // env에 저장했던 owner app이 배열로 session에 저장되기 때문에 index로 접근
]);

이제 Dabory Protocol22-API for WebApp을 활용하여 안전하게 API를 호출할 수 있습니다.

[WebApp] Protocal22-API 사용예제 (GoLang)

[WebApp] Protocal22-API 사용예제2

시작하기 전에

이 문서는 Dabory OwnerKey API for WebApp을 사용해 main app과 guest app 개발시 필요한 참고 정보를 안내합니다.

WebApp 사용예제

2. WebApp 사용 예제

📌 GateToken 발급 스케줄러

package main
func main() {
	// 새로운 고루틴(Goroutine) 실행: 백그라운드에서 주기적으로 실행됨
	go func() {
		for {
			// 1. UpdateGateTokenIfNeeded() 함수 호출 (GateToken 발급 및 업데이트)
			err := controllers_func.UpdateGateTokenIfNeeded()
			
			// 2. 만약 에러가 발생하면 로그를 남김
			if err != nil {
				e.ErrLog("UpdateGateTokenIfNeeded Error", err)
			}

			// 3. 2초 동안 대기 후 반복 (즉, 2초마다 실행됨)
			time.Sleep(2 * time.Second)
		}
	}()

	// 주의: main 함수가 종료되면 고루틴도 종료됨
	select {} // main 함수가 종료되지 않도록 무한 대기
}

📌 "OwnerKey"를 활용한 GateToken, BackUrl 반환

Host의 dabory-app/gate-token-get을 호출 -> Host -> main_api (GateToken) 반환


// GateToken을 요청하는 함수
func UpdateGateTokenIfNeeded() error {
	myOwnerKey := "My_OwnerKey" //OwnerKey (GateToken 발급 주체 선정을 위해 사용)

	// GateToken을 요청 (OwnerKey를 사용하여 요청)
	err := locals.GuestGateTokenGets(myOwnerKey)
	if err != nil {
		fmt.Println("GateToken 요청 실패:", err)
		return err
	}

	return nil
}


type AppApi struct {
	ApiUrl    string
	GateToken string
}

var GAppApis [2]AppApi // GateToken, ApiUrl 저장 장소 

func GuestGateTokenGets(myOnwerKey string) error { 
	appType := 0 //Dbupdate
	// 0:keypair, 1:Dbu  // "SsoConnString" Must be Deprecated

	var err error

	if myOnwerKey != "" { 
		// e.LogStr("lskdjqfals", e.LogFuncName()+"; GuestGateTokenOwner with OwnerKey: "+myOnwerKey)
		_, _, err = GuestGateTokenOwner(appType, "https://host_domain_URL.com", myOnwerKey) // app type -> OwnerCode
      // Host Domain URL, OwnerKey를 매개변수로 던짐
		if err != nil {
			return e.ErrLog(e.FuncRun("23rfsr3qrase", e.CurrFuncName()), err)
		}
	} 

	return nil
}

func GuestGateTokenOwner(appType int, pivotUrl string, ownerKey string) (string, string, error) { // HOST URL/dabory-app ->  pivot URL
	var appTypeCode string
	if appType == 0 {
		appTypeCode = "keypair"
	} else if appType == 1 {
		appTypeCode = "dbupdate"
	}

	if GAppApis[appType].GateToken != "" { // 할당되어 있는 경우 (이미 GateToken이 있는 경우)
		// fmt.Println("34092ujfa : "+"Using GateToken in ARRAY to access : ", GAppApis[0].GateToken)
	} else { // (GateToken이 없는 경우 발급 로직)
		fmt.Println("34092ujfa : " + "isn't exist GateToken in ARRAY to access ")

		vGt := &GateTokenGetReq{
			OwnerKey: ownerKey,
		}
		bodyBytes, _ := json.Marshal(vGt)

		frontUrl := pivotUrl + "/dabory-app/gate-token-get" 
		msgBytes, staInt, err := HttpResponseSimplePost("POST", frontUrl, bodyBytes) 
        // Strong -> Host Lalavel로 Http 요청 -> Lalavel -> main_api로 GateToken 요청
		e.LogStr("23rfsr3qr-GateTokenGetReq", e.LogFuncName()+";  Raravel frontUrl : "+frontUrl)
		if err != nil {
			return "", "", e.ErrLog(e.FuncRun("45425fd34sd-The HTTP request "+frontUrl, e.CurrFuncName()), err)
		}

		if staInt != 200 {
			TrackFailure() // 요청 실패 시 실패 기록 추가
			fmt.Println("GateToken 요청 실패:", err, "(최근 1시간 내 실패 횟수:", len(failTimestamps), ")", "반환 Code : ", staInt)

			// 최근 1시간 동안 실패 횟수가 maxFailures(3) 이상이면 프로그램 종료
			if len(failTimestamps) >= maxFailures {
				fmt.Println("1시간 내 GateToken 요청이", maxFailures, "번 실패 -> 스케줄러를 종료")
				os.Exit(1) // 프로그램 종료
			}

			return "", "", errors.New(e.FuncRun("87ty344ra3-Request Fail "+string(msgBytes), e.CurrFuncName()))
		}

		failTimestamps = []int64{} // 성공 시 실패 기록 초기화

		ret := &struct {
			ApiUrl    string 
			GateToken string
		}{}

		if err := json.Unmarshal(msgBytes, ret); err != nil {  // GateToken과 BackendUrl을 ret 구조체에 할당
			return "", "", e.ErrLog(e.FuncRun("45425fd34sd-Json Format "+frontUrl, e.CurrFuncName()), err)
		}
      // 새로 받은 GateToken을 전역 변수에 저장
		GAppApis[appType].ApiUrl = ret.ApiUrl
		GAppApis[appType].GateToken = ret.GateToken
		e.OkLog("Just Added GateToken in ARRAY to access AppType: " + appTypeCode)
		e.OkLog("Just Added GateToken in ARRAY to access AppType: " + ret.GateToken)
		e.OkLog("Just Added GateToken in ARRAY to access AppType: " + ret.ApiUrl) // main_api URL

	}
	return GAppApis[appType].ApiUrl, GAppApis[appType].GateToken, nil
}

📌 발급받은 GateToken을 사용하여 main_api 요청

// 🔹 API 요청을 수행하는 함수
func process() {
	// 1. GateToken과 API URL 가져오기
	apiUrl := locals.GAppApis[0].ApiUrl    // API 요청을 보낼 기본 URL
	gateToken := locals.GAppApis[0].GateToken // API 요청 시 필요한 인증 토큰

	// 2. 요청할 API 엔드포인트 설정 (credit-page 요청)
	mainApiURL := apiUrl + "/credit-page"

	// 3. 요청 바디 구성 (전달할 데이터)
	requestBody := map[string]interface{}{
		"PageVars": map[string]interface{}{
			"Fields":     "credit_no", 
			"Limit":      1,          
			"Desc":       "id",       
			"MyFilter":   "",         
			"QueryCnt":   0,          
			"Query":      "",         
			"Asc":        "",         
			"Offset":     0,          
			"ReturnJson": "",         
		},
	}

	// 4. API 요청 실행 (GateToken 포함)
	Body, err := RequestWithGateToken(mainApiURL, gateToken, requestBody)
	if err != nil {
		// 요청 실패 시 에러 로그 출력
		e.ErrLog("API 요청 실패: ", err)
		return
	}

	// 5. 응답 데이터 출력
	fmt.Println("API 응답 데이터:", string(Body))
}

📌 저장된 GateToken으로 요청 (만료된 GateToken 재 발급)

// GateToken을 사용하여 API 요청을 보내는 함수
func RequestWithGateToken(mainApiURL string, gateToken string, requestBody map[string]interface{}) ([]byte, error) {
	// 1. HTTP 요청 보내기 (기존 GateToken 사용)
	resp, body, err := SendHttpRequest(mainApiURL, gateToken, requestBody)
	if err != nil {
		fmt.Println("HTTP 요청 실패:", err)
		return nil, err
	}
	defer resp.Body.Close()

	fmt.Println("응답 본문:", string(body)) // API 응답 출력

	// 2. 응답 코드가 505라면 -> GateToken 만료 (새로운 GateToken 발급 필요)
	if resp.StatusCode == 505 {
		fmt.Println("GateToken 만료! 새로운 GateToken 발급 시도..")

		// 기존 만료된 GateToken 초기화
		locals.GAppApis[0] = locals.AppApi{}

		// 스케줄러가 새로운 GateToken이 얻어올 때까지 대기 (최대 5초마다 확인)
		for locals.GAppApis[0].GateToken == "" {
			fmt.Println("새로운 GateToken 발급 중..")
			time.Sleep(5 * time.Second)
		}

		fmt.Println("새로운 GateToken 발급 완료!")

		// 새로운 GateToken으로 API 재요청
		newGateToken := locals.GAppApis[0].GateToken
		resp, body, err := SendHttpRequest(mainApiURL, newGateToken, requestBody)
		if err != nil {
			fmt.Println("HTTP 요청 실패:", err)
			return nil, err
		}
		defer resp.Body.Close()

		// 새로운 요청 응답 확인
		if resp.StatusCode == 200 {
			e.OkLog("새로운 GateToken을 사용한 HTTP 요청 성공!")
			return body, nil
		} else {
			return nil, fmt.Errorf("새로운 GateToken 요청 실패, 상태 코드: %d", resp.StatusCode)
		}
	}

	// 기존 GateToken으로 요청 성공한 경우
	e.OkLog("기존 GateToken을 사용한 HTTP 요청 성공!")
	return body, nil
}

// HTTP 요청을 보내는 함수
func SendHttpRequest(mainApiURL string, gateToken string, requestBody map[string]interface{}) (*http.Response, []byte, error) {
	// 1. JSON 데이터로 변환
	jsonData, err := json.Marshal(requestBody)
	if err != nil {
		fmt.Println("JSON 변환 실패:", err)
		return nil, nil, err
	}

	// 2. HTTP 요청 생성 (POST 요청)
	req, err := http.NewRequest("POST", mainApiURL, bytes.NewBuffer(jsonData))
	if err != nil {
		fmt.Println("HTTP 요청 생성 실패:", err)
		return nil, nil, err
	}

	// 3. HTTP 헤더 설정 (GateToken 포함)
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("GateToken", gateToken)

	// 4. HTTP 요청 실행
	client := &http.Client{}
	resp, err := client.Do(req)
	if err != nil {
		fmt.Println("HTTP 요청 실패:", err)
		return nil, nil, err
	}

	// 5. 응답 데이터 읽기
	body, err := io.ReadAll(resp.Body)
	if err != nil {
		fmt.Println("응답 본문 읽기 실패:", err)
		return nil, nil, err
	}

	// 6. 응답 로그 출력
	fmt.Println("응답 코드:", resp.StatusCode)
	fmt.Println("응답 본문:", string(body))

	return resp, body, nil
}

OwnerKey를 활용한 게시판 연동 예제

시작하기 전에

이 문서는 OwnerKey를 사용하여 Guest App에서 Owner App의 게시판 데이터 연동할 때 필요한 참고정보를 제공 및 설명합니다.

예제실행전에 아래 준비사항들을 반드시 준비해주시기 바랍니다.

오너 사이트로부터 제공받은 OwnerKey (env 파일에 저장)
css 파일( 디자인 커스터마이징의 경우 )
app 등록하기
owner app의 게시판 코드
env 파일에 저장된 OWNER_APP_NAME

게시판 연동의 흐름

1. 제공받은 OwnerKey를 env 파일에 저장합니다.

2. owner app의 게시판 정보를 기반으로 guest app에 저장합니다.

3. main_menu를 등록합니다.

게시판 연동예제

위 이미지는 dabory compoable 사이트의 USE CASES 게시판(블로그)입니다. 이 게시판을 factory 사이트에서 연동하겠습니다.

- env 파일에 오너키 저장

먼저 .env 파일에 OwnerKey를 저장해야합니다. 만약 설정할 오너앱이 두개 이상 이상이라면 오너앱의 개수에 맞게 변수 끝에 _숫자를 입력하여 순서에 맞게 변수명을 입력합니다.

# [protocol22]
OWNER_APP_NAME=YOUR_OWNER_APP_NAME  # Owner APP의 이름 (자유롭게 지정)
GUEST_APP_OWNER_KEY=YOUR_OWNER_KEY  # Guest APP에서 발급받은 OwnerKey 입력
GUEST_APP_OWNER_URL=YOUR_OWNER_URL  # Owner APP의 URL 입력 (ex.https://composable.daboryhost.com)

OWNER_APP_NAME2=YOUR_OWNER_APP_NAME_2
GUEST_APP_OWNER_KEY2=YOUR_OWNER_KEY_2
GUEST_APP_OWNER_URL2=YOUR_OWNER_URL_2

OWNER_APP_NAME3=YOUR_OWNER_APP_NAME_3
GUEST_APP_OWNER_KEY3=YOUR_OWNER_KEY_3
GUEST_APP_OWNER_URL3=YOUR_OWNER_URL_3

💡 OwnerKey란?

OwnerKey는 GUSET APP이 MAIN APP의 API를 호출할 때 사용되는 고유한 인증 키입니다.
WebApp 방식에서는 OwnerKey를 .env 파일에 저장하고, API 요청 시 세션을 활용하여 사용합니다.

- 오너앱의 게시판 URL 확인

만약 오너사이트에서 제공받으려는 게시판 url을 모른다면 오너 사이트에서 해당 게시판 url을 확인할 수 있습니다.

(1). 오너 사이트인 composable에서 Use Cases를 클릭합니다.

(2). /bbs/list/use-cases를 복사하여 메모장에 붙여넣습니다.

- 홈페이지 메뉴 등록

(1). 슈퍼 유저 메뉴 - 시스템 관리(주의) - 홈페이지 메뉴 불러오기 메뉴로 진입합니다.

(2). 우측 상단의 메인메뉴 추가 버튼을 클릭합니다.

(3). 입력창을 모두 입력한 뒤 저장버튼을 클릭하여 저장합니다.

메뉴코드 : 메뉴코드는 메뉴의 순서와 상/하위 메뉴를 지정할 수 있습니다 . 예를들어 메뉴코드가 100000인 메뉴가 홈페이지 헤더 메뉴에 가장 먼저 위치하고 200000~900000인 메뉴가 순서대로 노출됩니다. 301000, 302000은 300000의 하위메뉴를 뜻합니다.

메뉴명 : 홈페이지 나타내려는 메뉴(게시판)의 이름

페이지 URI : 오너로부터 제공받은 게시판 URL을 입력한뒤 가장 끝부분에 env파일에 저장된 OWNER_APP_NAME 을 입력합니다.

예를들어 오너 사이트에서 제공받은 게시판 URI가 /bbs/list/use-cases 고 env파일에 저장된 OWNER_APP_NAME이 composable이라면 /bbs/list/use-cases/composable 이라고 입력합니다.

언어구분 : 원하는 언어형식을 선택합니다.

링크타입 : 게시판을 선택합니다.

종류 : primary를 선택합니다.

메뉴표시 누락 : 체크시 홈페이지에서 해당 메뉴가 노출되지 않습니다.

target=_blank 인가 : 체크시 홈페이지에서 해당 메뉴를 클릭했을때 새탭으로 열립니다.

PC에서누락 : 체크시 PC로 홈페이지에 접속했을때 해당 메뉴가 노출되지 않습니다.

Mobile에서누락 : 체크시 모바일로 홈페이지에 접속했을 때 해당 메뉴가 노출되지 않습니다.

테블릿에서누락 : 체크시 테블릭PC로 홈페이지에 접속했을 때 해당 메뉴가 노출되지 않습니다.

로그인경우만 : 체크시 로그인했을 경우에만 해당 메뉴가 노출됩니다.

로그아웃경우만 : 체크시 로그아웃했을 경우에만 해당 메뉴가 노출됩니다.

(4). 홈페이지에 접속하여 추가한 게시판이 노출되었는지 확인합니다.

(5). composable과 게시판 연동이 완료되었습니다.

Protocol22-API

개요

PROTOCOL22-API

OwnerKey 발급방법

Protocol22-API 종류

js방식과 app방식의 차이점

Protocol22-API 목록

요청 URL

매서드

응답 형식

설명

Protocol22-API 사용 함수 목록

Javascript

1. ownerApp

2. ownerApi

OwnerApi vs OwnerApp

OwnerApp :

OwnerApi :

[JavaScript] Protocal22-API 사용예제

시작하기 전에

JavaScript 방식의 API 호출 흐름

JavaScript 사용예제 (회원가입 구현)

script 선언과 변수설정

API 요청 함수(OwnerApp)

API 요청 함수(OwnerApi)

OwnerApi vs OwnerApp

OwnerApp()

OwnerApi()

ownerApi 호출 예제

- API를 호출하여 비밀번호 정책 (passwd-policy) 데이터를 가져오는 예제입니다.

ownerApp 호출 예제

- API를 호출하여 휴대폰 인증코드 (auth/send-smsConfirm)를 발송하는 예제입니다.

- API를 호출하여 이메일 인증코드 (auth/send-emailConfirm)를 발송하는 예제입니다.

[WebApp] Protocal22-API 사용예제 (PHP)

[WebApp] PROTOCOL22-API 사용예제

시작하기 전에

WebApp 방식의 Owner Key API 호출 흐름

WebApp 사용예제

- env 파일에 환경변수 저장

- Laravel에서 Owner API 호출

- API 호출 예제

[WebApp] Protocal22-API 사용예제 (GoLang)

[WebApp] Protocal22-API 사용예제2

시작하기 전에

WebApp 사용예제

2. WebApp 사용 예제

📌 GateToken 발급 스케줄러

📌 "OwnerKey"를 활용한 GateToken, BackUrl 반환

📌 발급받은 GateToken을 사용하여 main_api 요청

📌 저장된 GateToken으로 요청 (만료된 GateToken 재 발급)

OwnerKey를 활용한 게시판 연동 예제

시작하기 전에

게시판 연동의 흐름

게시판 연동예제

- env 파일에 오너키 저장

- 오너앱의 게시판 URL 확인

- 홈페이지 메뉴 등록