API Sender25

Através desta API, você pode enviar, consultar, listar o envio de mensagens de email.

Como Interagir com a API

Nossa API opera sobre o protocolo HTTPS e utiliza o formato JSON para troca de informações. Todas as requisições devem ser enviadas para https://br-app.sender25.com e requerem a inclusão do header de autenticação X-Server-API-Key com sua chave de API.

As requisições podem ser feitas utilizando métodos HTTP como GET e POST. Geralmente, as requisições que modificam o estado (como enviar) devem utilizar o método POST , com os parâmetros passados no corpo da requisição em formato JSON.

Recebendo Respostas

Todas as respostas da API são retornadas em formato JSON. Independentemente do resultado, você receberá uma estrutura padrão que se assemelha ao exemplo abaixo:

{
  "status": "success",       /* "success", "parameter-error" ou "error" */
  "time": 0.123,             /* Tempo de processamento no servidor */
  "flags": {                 /* Informações adicionais, como dados de paginação */
    /* ... */
  },
  "data": {                  /* Resultado da requisição ou detalhes do erro */
    /* ... */
  }
}

Status: O atributo status indica se a operação foi realizada com sucesso (success), se houve erro nos parâmetros (parameter-error) ou se ocorreu algum erro não categorizado (error).

Time: O atributo time informa quanto tempo a requisição levou para ser processada no servidor.

Flags: O atributo flags contém informações adicionais sobre a requisição, como detalhes de paginação quando aplicável.

Data: O atributo data possui os resultados da ação solicitada ou detalhes dos erros ocorridos.

Sobre os Códigos HTTP

A API Sender25 utiliza os códigos de status HTTP de forma complementar. Embora a resposta padrão sempre retorne o corpo com o atributo status, os seguintes códigos HTTP podem ser observados:

• 200 OK – Indica que a resposta foi entregue com sucesso. Contudo, o sucesso da ação é indicado pelo atributo status no corpo da resposta.
• 301 Moved Permanently ou 308 Permanent Redirect – Indica que a requisição deve ser enviada para outra URL, normalmente devido à exigência de utilizar o protocolo HTTPS.
• 500 Internal Server Error – Erro interno no servidor. Caso ocorra, reporte o problema à equipe de suporte.
• 503 Service Unavailable – A API está indisponível, possivelmente por manutenção ou problemas temporários.

Se precisar de ajuda ou tiver dúvidas, entre em contato com nossa equipe. Estamos prontos para auxiliá-lo na integração e uso da API Sender25.