Manual - API
Overview
Esta é a documentação de referência para a API do tipo REST da Trinity.
A própria API é baseada em recursos que são representados pelo formato JSON e são manipulados usando o protocolo HTTP.
Recursos
Você pode enviar mensagens através dos canais com suporte da Trinity.
Você também pode se inscrever em eventos e recebê-los em um webhook de sua escolha. Os eventos disponíveis para cada canal são:
- Mensagens: receba eventos de mensagens para mensagens enviadas e / ou recebidas.
- Status de mensagens: receba atualizações de status para mensagens enviadas.
Pré-requisitos
Antes de usar esta API, você precisa do seguinte:
- Conta Trinity: crie uma conta no site da plataforma Trinity
- Integrações: configure os canais desejados para enviar e / ou receber mensagens na página de integrações
- Token de API: crie um token de API no console de API
Visualize seu relatório de uso
Você também pode acessar a plataforma Trinity para visualizar suas Estatísticas.
Métodos HTTP
Métodos HTTP são usados para manipular recursos. Porém, como nem todos os recursos permitem todas as operações HTTP, observe OK a referência de cada recurso abaixo.
Métodos usados com endpoints de coleta:
Métodos utilizados nos endpoints:
Entendendo os erros
Quando ocorre um erro, a API retorna um código de status HTTP 4xx ou 5xx e o payload com o Error Object.
Códigos de erros detalhados abaixo:
Autenticação
Token
Para usar esta API, você precisa enviar o token da API em cada solicitação. O token deve ser enviado no cabeçalho HTTP ‘X-API-TOKEN’.
Exemplo: X-API-TOKEN: hKp94crjv9OF3UGrCpSXUJw1-UYHhRvLKNLt
Gere seu token no console API da plataforma Trinity seguindo abaixo:
1 – Acesse https://api.trinitytec.com.br
2 – Faça o login com as informações de sua conta
3 – Clique em “auth” e em seguida clique no símbolo 
4 – Insira seus dados de autenticação de sua conta e clique em “Authorize”
5 – Gere seu token considerando os campos:
* ip – defina um IP válido para utilizar a aplicação ou insira *.*.*.* para qualquer endereço de IP;
* lifetime – defina um valor de validade do seu token em dias; ou
* non_exp – para token que não expira. Defina o valor como “true”
6 – Em seguida clique em “Try it out”:
Você terá o resultado de cURL
SMS
O canal SMS pode ser utilizado após sua ativação na plataforma Trinity.
Os webhooks permitem que você receba eventos no URL configurado.
Remetente e destinatário de SMS
Quando você envia uma mensagem a um contato usando o canal SMS:
Destinatário: o número de telefone completo (incluindo o código do país) do contato.
Remetente: o alias da conta SMS conectada na plataforma Trinity.
Quando você recebe uma mensagem de um contato, o remetente e o destinatário são invertidos:
Destinatário: o alias da conta SMS conectada na plataforma Trinity.
Remetente: o número de telefone completo (incluindo código do país) do contato.
O remetente vai no atributo from e o receptor vai no atributo to do objeto de mensagem.
Enviando um SMS
Após gerar o seu token através da interface de API da Trinity, você pode enviar um SMS diretamente na plataforma seguindo os seguintes passos:
1 – Clique em “send_sms”
2 – Insira as informações necessárias, considerando as informações destacadas
Através do portal Trinity, podemos gerar tokens de autenticação, autorização de IPs e criação de canais para diferentes aplicações.
Informações complementares
A partir de mensagens MT, deve-se usar nosso modelo, mas com as credenciais definidas através do portal Trinity. Abaixo um modelo de URL de callback:
http://1.1.1.1:8001/api?username = <username> & password = <password> & ani = <ani> & dnis = <dnis> & message = <message> & command = submit & serviceType = <serviceType> & longMessageMode = <longMessageMode>
As solicitações de status têm o campo especial na configuração de canais e têm seu próprio formato como abaixo:
http://1.1.1.1:8001/api?username = <username> & password = <password> & messageId = <messageId> & command = query
Os callbacks de MO devem ser configurados no Portal (se estiverem conectados via portal).
Um cURL de exemplo para o envio de relatórios de entrega:
http: // 1.1.1.1: 8003 / api?dnis = $ dnis $ & username = SmsChannelUsername & password = SmsChannelPassword & command = entregar & dlvrM sgId = $ messageID $ & dlvrMsgStat = $ status $
Um exemplo de cURL para enviar MO:
http: // 1.1.1.1: 8003 / api? dnis = $ dnis $ & username = SmsChannelUsername & password = SmsChannelPassword & command = mo & message = $ message_text $