Nuestro PHP-SDK proporciona una interfaz sencilla para que los desarrolladores de PHP integren Quentn en tu aplicación. Las características incluyen:
- Fácil instalación de todas las dependencias con Composer
- Funciones integradas para cada API-Endpoint
- Funciones de ayuda para empezar con la autenticación Oauth 2.0
Por favor visita nuestro repositorio Github para más información.
Instalar el SDK
Recomendamos composer para instalar el SDK de Quentn-PHP. Para aprender más sobre Composer, por favor visita la Guía de Inicio de Composer.
Para instalar el SDK de Quentn-PHP con composer, simplemente ejecuta:
composer require quentn/php-sdk
También puedes añadir manualmente la dependencia a tu archivo composer.json:
{
"require": {
"quentn/php-sdk": "1.0.*"
}
}
Ejemplos
Carga automática
Añade autoload encima de cada fichero:
require __DIR__ . './vendor/autoload.php';
Crear un nuevo contacto
Este ejemplo muestra cómo crear un nuevo contacto.
require __DIR__ . './vendor/autoload.php';
$quentn = new Quentn\Quentn([
'api_key' => 'API_KEY',
'base_url' => 'BASE_URL',
]);
//check API key
if (!$quentn->test()) {
echo "key doesn't seem to work";
exit;
}
//create contact
$data = [
"first_name" => "Johnn",
"family_name" => "Doe",
"mail" => "johndoe@example.com",
];
try {
$get_response = $quentn->contacts()->createContact($data);
$contact_id = $get_response['data']['id'];
} catch (Exception $e) {
echo $e->getMessage();
}
Autenticación Oauth
Con la autenticación Oauth puedes obtener la url de la API y la clave de la API de un sistema de destino de forma automática. El usuario final sólo tiene que confirmar su aplicación con un clic.
Para registrar una app con Quentn, necesitas una cuenta de desarrollador Quentn. Envíanos un correo electrónico a info@quentn.com (o envía un ticket) para solicitar una cuenta de desarrollador.
Para iniciar el proceso OAuth, necesitas registrar tu aplicación con Quentn. Tras el registro, recibirá tu ID de cliente y tu secreto de cliente.
require __DIR__ . './vendor/autoload.php';
$quentn = new Quentn\Quentn();
$quentn->oauth()->setApp([
'client_id' => 'CLIENT_ID',
'client_secret' => 'CLIENT_SECRET',
'redirect_uri' => 'REDIRECT_URL',
]);
if($quentn->oauth()->authorize()) {
/*
do you stuff here
You can now access your App key and base url with:
$quentn->getApiKey();
$quentn->getBaseUrl();
*/
try {
$get_response = $quentn->contacts()->findContactById($contactId, 'first_name, mail');
} catch (Exception $e) {
echo $e->getMessage();
}
}
else {
// to get the Authorization URL you can use getAuthorizationUrl() function
echo '<a href="' . $quentn->oauth()->getAuthorizationUrl() . '">Click here to get authorize</a>';
}