Desarrolladores
Explora las herramientas para desarrolladores que ofrecemos
Versión de API 1.1
Esta documentación explica cómo registrar, configurar y desarrollar tu aplicación para que pueda utilizar nuestras API con éxito
Crear App
Para que tu aplicación pueda acceder a nuestras API, debe registrarla utilizando el Panel de App. El registro crea un App ID que nos permite saber quién eres tu y nos ayuda a distinguir tu aplicación de otras aplicaciones.
- Necesitarás crear una nueva aplicación Crear Nueva App
- Una vez que hayas creado tu aplicación, obtendrás tu app_id y app_secret
Acceder con
El sistema de inicio de sesión es una forma rápida y cómoda de crear cuentas e iniciar sesión en tu aplicación. Nuestro sistema de inicio de sesión permite dos escenarios: autenticación y solicitud de permisos para acceder a los datos de los usuarios. Puedes usar el sistema de inicio de sesión solo para la autenticación o para ambas funciones.
-
Para iniciar el proceso de inicio de sesión de OAuth, debes usar un enlace para su aplicación como este:
<a href="https://comunidad.soypuromexicano.mx/api/oauth?app_id=YOUR_APP_ID">Log in With Soy Puro Mexicano</a>
El usuario será redirigido a una página de inicio de sesión como ésta
-
Una vez que el usuario haya aceptado su aplicación, será redirigido a la URL de redireccionamiento de su aplicación con auth_key como esto:
https://mydomain.com/my_redirect_url.php?auth_key=AUTH_KEY
Esto auth_key válido solo para un uso único, por lo que una vez que lo hayas usado no podrás volver a usarlo y generará un nuevo código, deberás redirigir al usuario al inicio de sesión con el enlace nuevamente.
Access Token
Una vez que obtengas la aprobación del usuario de tu aplicación, inicia sesión con la ventana y regresa con el auth_key lo que significa que ahora estás listo para recuperar datos de nuestras API y para comenzar este proceso deberás autorizar tu aplicación y obtener la access_token y puedes seguir nuestros pasos para saber cómo conseguirlo.
-
Para obtener un token de acceso, realiza una solicitud HTTP GET al siguiente punto final de esta manera:
<?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 } ?>
Esto access_token válido solo por 1 hora, por lo que una vez que se vuelva inválido, deberás generar uno nuevo redirigiendo al usuario al inicio de sesión con el enlace nuevamente.
APIs
Una vez que obtengas tu access_token Ahora puedes recuperar información de nuestro sistema a través de solicitudes HTTP GET que admiten los siguientes parámetros
Punto de acceso | Descripción |
---|---|
api/get_user_info |
obtener información del usuario |
Puedes recuperar información del usuario de esta manera
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"); }
El 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": "" } }