Oktave met en place une API pour les comptes entreprise et supérieurs afin de mettre en place des workflow avancés avec l'intégration de services extérieurs.
Authentification
L'API Oktave utilise le mécanisme d'authentification oAuth2.
Pour cela vous devez générer un identifiant de client dans votre compte.
Vous obtiendrez ainsi un client ID et un client secret utilisable avec notre SDK.
Note : Pour une meilleure gestion vous pouvez générer plusieurs clients si vous le souhaitez en leur donnant un nom.
L'utilisation du SDK simplifie la mise en place de l'authentification et gérant totalement cette partie en fonction de votre configuration.
Attention ! Dans le cadre d'une gestion multi-comptes, l'identifiant de votre team est obligatoire lors des appels API afin d'assurer la bonne réception de vos requêtes.
Utilisation
Cette API est limitée et vous permet simplement d'envoyer vos campagnes email / sms et de valider les signatures de vos requêtes Oktave entrantes dans le cadre des webhooks.
Lors d'un partage via API de vos campagnes email / sms, Oktave vous fournira l'identifiant à utiliser pour exécuter les appels ainsi que des exemples d'utilisation comme ci-après.
Exemple via cURL :
## cURL example
# First get your access token
$ curl -X POST https://app.oktave.co/api/tokens \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{"grant_type": "client_credentials", "client_id": "YOUR_CLIENT_ID", "client_secret": "YOUR_CLIENT_SECRET"}'
# This will return the response below
# {"token_type": "Bearer", "expires_in": 31622400, "access_token": "YOUR_REQUESTED_ACCESS_TOKEN"}
# store this access_token (and expires_in) for later use
$ curl -X PUT https://app.oktave.co/api/emitters/YOUR_CAMPAIGN_ID/send \
-H 'Authorization: Bearer YOUR_REQUESTED_ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{"recipients": ["email1@domain.com", "email2@domain.com"]}'
Exemple via notre SDK PHP :
<?php
// PHP example with Oktave PHP SDK
$config = [
'client_id' => YOUR_CLIENT_ID,
'client_secret' => YOUR_CLIENT_SECRET,
'webhook_secret' => YOUR_WEBHOOK_SECRET,
];
$oktave = new \Oktave\Client($config);
try {
$oktave->campaigns->send(YOUR_CAMPAIGN_ID, [
'email1@domain.com',
'email2@domain.com',
]);
} catch (\Throwable $e) { // ... }
Retrouvez ici un exemple d'utilisation de l'API pour la validation des webhooks.
Le SDK PHP est accessible à cette adresse : https://github.com/ConfidencesApp/oktave-sdk-php
Retrouvez également plus de cas d'usage à cette adresse : https://github.com/ConfidencesApp/oktave-sdk-php/blob/master/README.md