Para que serve a API

API (Application Programming Interface) — é uma funcionalidade para a interação entre diferentes programas. Para as pessoas existem interfaces separadas, por exemplo um site. A API serve para diversas integrações. A Sender Solutions tem uma API que funciona por meio de requisições HTTP no formato JSON. O acesso à API é fornecido para todos os planos tarifários do projeto, incluindo o plano tarifário gratuito. Você pode usar a API da Sender Solutions para uma integração mais completa e flexível. O formato previsto de uso da API — a partir do seu site com base em gatilhos. Por exemplo, quando um assinante é criado no seu site, o site executa uma requisição à API, e um assinante com os mesmos dados é criado na Sender Solutions.

Início do uso da API

1. Para usar a API, você precisa criar um projeto na Conta pessoal da Sender Solutions.
2. Em seguida, na página de configurações do projeto, crie uma chave API. É uma chave de acesso única à API no nível desse projeto. Mantenha-a em segredo. Se houver suspeita de que a chave foi comprometida, comece a usar uma nova chave o mais rápido possível, e desative ou exclua a chave comprometida.
3. Para um mesmo projeto é possível criar várias chaves API — todas são equivalentes. Isso pode ser útil se você tiver vários aplicativos diferentes que executarão requisições à API.
4. A chave API deve ser transmitida no cabeçalho HTTP Authorization.
5. Transmita o corpo da requisição no formato JSON, e no cabeçalho Content-Type indique o valor application/json.
6. Oriente-se pelo status HTTP da resposta. Se o código for 200 — tudo ocorreu com sucesso. Se o código for 500 — ocorreu um erro.
7. A resposta da API, em geral, é retornada no formato JSON. No nível raiz está presente a chave "success" com os valores possíveis true / false.
   Exemplo de resposta bem-sucedida:
   {
    "success": true
}
   
   Exemplo de resposta com erro:
   {
    "error": "Some error description",
    "success": false
}
   No corpo de uma resposta bem-sucedida pode haver dados adicionais dependendo da requisição específica.
8. Para trabalhar com a API não é necessário o suporte a cookies ou sessões.

Recursos úteis

Composer pacote para trabalhar com a API em php: sender-solutions/php-sdk e o mesmo pacote no github: Sender-Solutions/php-sdk

Postman a coleção de requisições à API está disponível no link