Conhecendo a API

A API da ZapMe possui uma mecânica poderosa que viabiliza flexibilidade de uso de diferentes formas e jeitos. O conceito do sistema gira em torno de etapas que ocorrem desde o recebimento da requisição até a sua resposta final, para garantir uma performance diferente e com o menor tempo possível.

Método Principal

A API aceita os seguintes métodos:

  • POST

Requisições via HTTP POST

  • GET

Requisições via HTTP GET (parâmetros inseridos na URL)

Importante

Independente do método HTTP é fundamental que os parâmetros sejam enviados corretamente.

Parâmetros da API

Independente do tipo do método, os seguintes parâmetros devem ser atendidos:

  • api ou u ou user

Tipos de referências à “API”, exemplo: api-xxxxxxxxxxxxxxxxxxxx

  • secret ou p ou pw

Tipos de referências à “Chave Secreta”, exemplo: 0123456789 (somente números)

  • method

Referência direta ao método a ser utilizado, saiba mais sobre clicando aqui

Aviso

Existe dois formatos de retornos aceitos pela API: json (comum e padrão) e XML. Você pode definir o parâmetro format como: xml ou json para definir o retorno. (Observação: o arquivo SDK entregue pela ZapMe só retorna formato json)

Importante

Além dos parâmetros apresentados acima, que são obrigatórios de todas as requisições, atente-se a enviar todos os parâmetros necessários de acordo com o method utilizado

Envio das Requisições

Toda e qualquer requisição deve ser enviada ao end-point:

Aviso

A API aceita requisições com SSL (HTTPS), exemplo: https://api.zapme.com.br. Caso seu ambiente suporte este recurso, prefira utiliza-lo para que a tramitação dos dados seja segura. Caso contrário, utilize o formato sem SSL (HTTP), exemplo: http://api.zapme.com.br

Importante

Em alguns casos as requisicões do tipo GET poderão necessitar que você informe o arquivo index.php no final do end-point, ficando desta forma: http://api.zapme.com.br/index.php