Versão da API 1.1

Esta documentação explica como registar, configurar e desenvolver a tua app para usares as nossas APIs com sucesso

Criar app

Para a tua app aceder às nossas APIs, tens de a registar através do Painel da app. O registo cria um ID da app que nos permite saber quem és e distinguir a tua app das outras.

1. Precisarás de criar uma nova app Criar nova app
2. Depois de criares a tua app, obterás o teu app_id e app_secret

Iniciar sessão com

O sistema Iniciar sessão com é uma forma rápida e conveniente de as pessoas criarem contas e iniciarem sessão na tua app. Permite dois cenários: autenticação e pedido de permissões para aceder a dados. Podes usá-lo apenas para autenticação ou para autenticação e acesso a dados.

1. Para iniciar o processo de início de sessão OAuth, precisas de usar uma ligação da tua app como esta:

   <a href="https://comunidad.soypuromexicano.mx/api/oauth?app_id=YOUR_APP_ID">Log in With Soy Puro Mexicano</a>

   O utilizador será redirecionado para a página Iniciar sessão com, assim

   
2. Quando o utilizador aceitar a tua app, será redirecionado para o URL de redirecionamento da app com auth_key assim:

   https://mydomain.com/my_redirect_url.php?auth_key=AUTH_KEY

   Isto auth_key válido apenas para uma utilização. Depois de o usares, não poderás usá-lo novamente e, para gerar um novo código, precisas de redirecionar o utilizador novamente para a ligação de início de sessão.

Token de acesso

Quando obtiveres a aprovação do utilizador na janela Iniciar sessão com da tua app e fores devolvido com o auth_key o que significa que já estás pronto para obter dados das nossas APIs. Para iniciar este processo, precisas de autorizar a tua app e obter o access_token e podes seguir os nossos passos para saberes como o obter.

1. Para obter um token de acesso, faz um pedido HTTP GET ao seguinte endpoint, assim:

           <?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://comunidad.soypuromexicano.mx/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 apenas durante 1 hora. Quando expirar, precisas de gerar outro ao redirecionar o utilizador novamente para a ligação de início de sessão.

APIs

Quando obtiveres o teu access_token Agora podes obter informações do nosso sistema via pedidos HTTP GET, que suportam os seguintes parâmetros

Podes obter as informações do utilizador assim

        if(!empty($json['access_token'])) {
            $access_token = $json['access_token']; // your access token
            $get = file_get_contents("https://comunidad.soypuromexicano.mx/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": ""
          }
        }