문서 (Documentation)

API Version 1.1

이 문서에서는 API를 성공적으로 사용할 수 있도록 앱을 등록, 구성 및 개발하는 방법을 설명합니다

앱 (App) 만들기

당신의 앱(App)이 우리의 API에 접근하기 위해서, 당신은 당신의 앱(App)을 사용하여 등록해야 합니다 앱 대시보드 (App Dashboard). 앱을 등록하면 앱 ID가 생성되어, 귀하의 앱이 다른 앱과 구분되어 서비스되고 도움을 받을 수 있습니다.

  1. 당신은 새로운 앱(App)을 만들어야 할 것입니다 새 App 추가
  2. 한번 앱을 만들고 나면, 다음 정보를 얻을 수 있습니다 app_id and app_secret
Log in With

로그인 시스템은 사용자가 계정을 만들고, 앱에 로그인할 수 있는 빠르고 편리한 방법입니다. 우리의 로그인 시스템은 사용자 인증과 사용자 데이터에 액세스할 수 있는 권한 요청을 요청할 수 있는 두 가지 시나리오를 제공합니다. 당신은 사용자 인증 및 데이터 액세스를 간단한 로그인을 통하여 사용할 수 있습니다.

  1. OAuth 로그인 프로세스를 시작할 때, 당신은 당신의 앱에 이와 같은 링크를 사용할 필요가 있습니다:
    <a href="https://cuoworld.com/api/oauth?app_id=YOUR_APP_ID">Log in With 큐오월드</a>

    사용자는 다음과 같은 로그인 페이지로 리다이렉트로 연결됩니다

  2. 한번 사용자가 당신의 앱 사용을 수락하면, 사용자는 당신의 앱 리다이렉트 URL로 리다이렉트 될 것입니다 auth_key like this:
    https://mydomain.com/my_redirect_url.php?auth_key=AUTH_KEY
    This auth_key 인증 코드는 한 번만 사용할 수 있으므로 일단 한번 사용하면 다시 사용할 수 없으며, 새 코드를 생성할 경우 다시 링크로 로그인해서 유저 리다이렉트 하는 것이 필요합니다.
Access Token

당신이 당신의 앱의 사용자 승인을 얻고 로그인 창과 함께 반환되면 auth_key 그것은 당신이 이제 우리의 APIs로부터 데이터를 검색할 준비가 되었다는 것을 의미합니다 그리고 이 프로세스를 시작하기 위해 당신은 당신의 앱을 authorize 인증하고 그리고 그것을 얻을 필요가 있을 것입니다 access_token 그리고 당신은 그것을 얻는 방법을 배우기 위해 우리의 Step들을 팔로우 할 수 있습니다.

  1. 액세스 토큰(access token)을 얻으려면 다음과 같은 HTTP GET request 를 수행하십시오:
                <?php
                $app_id = "YOUR_APP_ID"; // your app id
                $app_secret = "YOUR_APP_SECRET"; // your app secret
                $auth_key = $_GET['auth_key']; // the returned auth key from previous step
    
                $get = file_get_contents("https://cuoworld.com/api/authorize?app_id=$app_id&app_secret=$app_secret&auth_key=$auth_key");
    
                $json = json_decode($get, true);
                if(!empty($json['access_token'])) {
                    $access_token = $json['access_token']; // your access token
                }
                ?>                                                                                                
                                
    This access_token 1시간 동안만 유효하므로, 한번 무효화되면 다시 링크로 사용자를 리디렉션하여 새로운 링크로 전환해야 합니다.
APIs

Once you get your access_token 이제 다음 파라메터를 지원하는 HTTP GET 요청을 통해 우리 시스템에서 정보를 검색할 수 있습니다

Endpoint 설명
api/get_user_info

사용자 정보 가져오기

다음과 같이 사용자 정보를 검색할 수 있습니다

            if(!empty($json['access_token'])) {
                $access_token = $json['access_token']; // your access token
                $get = file_get_contents("https://cuoworld.com/api/get_user_info?access_token=$access_token");
            }
                        

결과는 다음과 같습니다:

            {
              "user_info": {
              "user_id": "",
              "user_name": "",
              "user_email": "",
              "user_firstname": "",
              "user_lastname": "",
              "user_gender": "",
              "user_birthdate": "",
              "user_picture": "",
              "user_cover": "",
              "user_registered": "",
              "user_verified": "",
              "user_relationship": "",
              "user_biography": "",
              "user_website": ""
              }
            }