Versão da API 1.1

Esta documentação explica como registrar, configurar e desenvolver seu aplicativo para que você possa usar nossas APIs com sucesso

Criar Aplicativo

Para que seu aplicativo acesse nossas APIs, você deve registrá-lo usando o Painel do Aplicativo. O registro cria um ID de Aplicativo que nos permite saber quem você é e nos ajuda a distinguir seu aplicativo de outros.

  1. Você precisará criar um novo Aplicativo Criar Novo Aplicativo
  2. Depois de criar seu Aplicativo, você receberá seu app_id e app_secret
Entrar com

O sistema 'Entrar com' é uma maneira rápida e conveniente para as pessoas criarem contas e fazerem login no seu aplicativo. Nosso sistema permite dois cenários: autenticação e solicitação de permissões para acessar dados das pessoas. Você pode usar o sistema 'Entrar com' apenas para autenticação ou para ambos.

  1. Iniciando o processo de login OAuth, você precisa usar um link para seu aplicativo como este:
    <a href="https://cristfy.com/api/oauth?app_id=YOUR_APP_ID">Log in With Cristfy</a>

    O usuário será redirecionado para a página 'Entrar com' como esta

  2. Assim que o usuário aceitar seu aplicativo, ele será redirecionado para a URL de Redirecionamento com auth_key como este:
    https://mydomain.com/my_redirect_url.php?auth_key=AUTH_KEY
    Isto auth_key válido apenas para uso único; assim que utilizado, não será possível usá-lo novamente e, para gerar um novo código, você precisará redirecionar o usuário ao link de login novamente.
Token de Acesso

Depois de obter a aprovação do usuário na janela 'Entrar com' do seu aplicativo e retornar com o auth_key o que significa que agora você está pronto para recuperar dados de nossas APIs e, para iniciar este processo, você precisará autorizar seu aplicativo e obter o access_token e você pode seguir nossos passos para aprender como obtê-lo.

  1. Para obter um token de acesso, faça uma requisição HTTP GET para o seguinte endpoint como este:
    <?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
    
    // Prepare the POST data
    $postData = [
      'app_id' => $app_id,
      'app_secret' => $app_secret,
      'auth_key' => $auth_key
    ];
    
    // Initialize cURL
    $ch = curl_init('https://cristfy.com/api/authorize');
    
    // Set cURL options for POST
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_POST, true);
    curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($postData));
    
    // Execute request
    $response = curl_exec($ch);
    
    // Check for cURL errors
    if (curl_errno($ch)) {
      die('cURL error: ' . curl_error($ch));
    }
    
    curl_close($ch);
    
    // Decode the JSON response
    $json = json_decode($response, true);
    
    // Use the access token if available
    if (!empty($json['access_token'])) {
      $access_token = $json['access_token']; // your access token
    }
    ?>
    
    Isto access_token válido por apenas 1 hora; assim que expirar, você precisará gerar um novo redirecionando o usuário ao link de login novamente.
APIs

Assim que você obtiver seu access_token Agora você pode recuperar informações do nosso sistema via requisições HTTP GET que suportam os seguintes parâmetros

Endpoint Descrição
api/get_user_info

obter informações do usuário

Você pode recuperar informações do usuário assim

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

O resultado será:

{
    "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": ""
    }
}
Cristfy https://cristfy.com