SDK PHP da Unimatrix

Instalação

Usar o Composer é a forma recomendada de instalar o SDK da Unimatrix para PHP, que está disponível no Packagist.

Execute o seguinte comando para adicionar unimtx/uni-sdk como uma dependência ao seu projeto:

composer require unimtx/uni-sdk

Uso

O exemplo a seguir mostra como usar o SDK PHP da Unimatrix para interagir com os serviços da Unimatrix.

Inicializar um cliente

use Uni\UniClient;

$client = new UniClient([
  'accessKeyId' => 'seu id de chave de acesso',
  'accessKeySecret' => 'seu segredo de chave de acesso' // se usar modo de autenticação simples, delete esta linha
]);

ou você pode configurar suas credenciais por variáveis de ambiente:

export UNIMTX_ACCESS_KEY_ID=seu_id_de_chave_de_acesso
export UNIMTX_ACCESS_KEY_SECRET=seu_segredo_de_chave_de_acesso

Enviar SMS

Envie uma mensagem de texto para um único destinatário.

use Uni\UniClient;
use Uni\UniException;

$client = new UniClient();

try {
  $resp = $client->messages->send([
    'to' => '+1206880xxxx', // no formato E.164
    'text' => 'Seu código de verificação é 2048.'
  ]);
  var_dump($resp->data);
} catch (UniException $e) {
  print_r($e);
}

Envie uma mensagem usando um template com variáveis.

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

Enviar OTP

Envie um código de passagem única (OTP) para um destinatário. O exemplo a seguir enviará um código de verificação gerado automaticamente para o usuário.

use Uni\UniClient;
use Uni\UniException;

$client = new UniClient();

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

Verificar OTP

Verifique o código de passagem única (OTP) fornecido pelo usuário. O exemplo a seguir verificará se o código de verificação fornecido pelo usuário está correto.

use Uni\UniClient;
use Uni\UniException;

$client = new UniClient();

$resp = $client->otp->verify([
  'to' => '+1206880xxxx',
  'code' => '123456' // o código fornecido pelo usuário
]);
var_dump($resp->valid);