Zum Hauptinhalt gehen

PHP SDK

Unser PHP-SDK bietet eine einfache Schnittstelle für PHP-Entwickler, um Quentn in ihre Anwendung zu integrieren. Die Funktionen umfassen:

  • Einfache Installation aller Abhängigkeiten mit Composer
  • Integrierte Funktionen für jeden API-Endpunkt
  • Hilfsfunktionen für den Einstieg in die Oauth 2.0-Authentifizierung

Bitte besuche unser Github Repository für weitere Informationen.

SDK installieren

Wir empfehlen die Verwendung von Composer, um das Quentn-PHP-SDK zu installieren. Um mehr über Composer zu erfahren, besuche bitte den Composer Getting Started Guide.

Um das Quentn-PHP-SDK mit Composer zu installieren, führst du einfach aus:

composer require quentn/php-sdk

Du kannst die Abhängigkeit auch manuell zu deiner composer.json-Datei hinzufügen:

{
  "require": {
    "quentn/php-sdk": "1.0.*"
  }
}

Beispiele

Autoload

Autoload am Anfang jeder Datei hinzufügen:

require __DIR__ . './vendor/autoload.php';

Einen neuen Kontakt anlegen

Dieses Beispiel zeigt, wie du einen neuen Kontakt erstellst.

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();
}

 

Oauth Authentifizierung

Mit der Oauth-Authentifizierung bist du in der Lage, die API-Url und den API-Schlüssel von einem Zielsystem automatisch zu erhalten. Der Endnutzer muss lediglich deine App einmalig mit einem Klick bestätigen. 

Um eine App bei Quentn zu registrieren, benötigst du einen Quentn-Developer-Account. Bitte schreibe uns eine E-Mail an info@quentn.com (oder schreibe uns ein Ticket), um einen Developer-Account zu beantragen. 

Um den OAuth-Prozess zu starten, musst du deine Anwendung bei Quentn als App registrieren. Nach der Registrierung erhältst du deine Client ID und deinen Client Secret.

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>';   
}

Verwandte Beiträge