SDK PHP de Unimatrix

Installation

Utiliser Composer est la manière recommandée d'installer le SDK Unimatrix pour PHP, qui est disponible sur Packagist.

Exécutez la commande suivante pour ajouter unimtx/uni-sdk comme dépendance à votre projet :

composer require unimtx/uni-sdk

Utilisation

L'exemple suivant montre comment utiliser le SDK PHP Unimatrix pour interagir avec les services Unimatrix.

Initialiser un client

use Uni\UniClient;

$client = new UniClient([
  'accessKeyId' => 'votre access key id',
  'accessKeySecret' => 'votre access key secret' // si vous utilisez le mode d'authentification simple, supprimez cette ligne
]);

ou vous pouvez configurer vos identifiants par des variables d'environnement :

export UNIMTX_ACCESS_KEY_ID=votre_access_key_id
export UNIMTX_ACCESS_KEY_SECRET=votre_access_key_secret

Envoyer SMS

Envoyer un message texte à un seul destinataire.

use Uni\UniClient;
use Uni\UniException;

$client = new UniClient();

try {
  $resp = $client->messages->send([
    'to' => '+1206880xxxx', // au format E.164
    'text' => 'Votre code de vérification est 2048.'
  ]);
  var_dump($resp->data);
} catch (UniException $e) {
  print_r($e);
}

Envoyer un message en utilisant un modèle avec des variables.

$client->messages->send([
  'to' => '+1650253xxxx',
  'signature' => 'Unimatrix',
  'templateId' => 'pub_otp_fr',
  'templateData' => [
    'code' => '2048'
  ]
]);

Envoyer OTP

Envoyer un code à usage unique (OTP) à un destinataire. L'exemple suivant enverra un code de vérification généré automatiquement à l'utilisateur.

use Uni\UniClient;
use Uni\UniException;

$client = new UniClient();

$resp = $client->otp->send([
  'to' => '+1206880xxxx'
]);
var_dump($resp->data);

Vérifier OTP

Vérifier le code à usage unique (OTP) fourni par un utilisateur. L'exemple suivant vérifiera si le code de vérification fourni par l'utilisateur est correct.

use Uni\UniClient;
use Uni\UniException;

$client = new UniClient();

$resp = $client->otp->verify([
  'to' => '+1206880xxxx',
  'code' => '123456' // le code fourni par l'utilisateur
]);
var_dump($resp->valid);