Formatação
A API da plataforma é uma aplicação RESTful. Isso quer dizer que cada serviço está disponível em uma URL específica, que deve ser acessada via HTTP, utilizando o método (POST ou PUT) apropriado, conforme documentação individual de cada serviço.
UTF-8
Ocharset padrão para chamadas à API é o UTF-8.
Para maiores Informações sobre essa codificação, consulte:
https://tools.ietf.org/html/rfc3629
JSON
JSON (JavaScriptObjectNotation) é um padrão para descrição de dados para intercâmbio entresistemas. Ele é mais simples e mais leve que o XML.
Por padrão toda a comunicação utiliza dados no formato JSON, tanto para request quanto para response
|
“Devido a essa padronização, para as chamadas POST e PUT é necessário Informar o HTTP Header content-type: application/json. Do contrário, você receberá um erro HTTP 415: Unsupported Media Type.” É necessário Informartambém o cabeçalho "Accept: application/json" nas requisições, sem exceção! |
O protocolo padrão para comunicação com a API é o HTTP versão 1.1. Para maiores Informações sobre esse protocolo, consulte:
AUTENTICAÇÃO
A autenticação é feita através de um token chamado ApiKey. Ao habilitar a API para você forneceremos uma string secreta e única que será usada para efetuar todas as operações. Em cada chamada à API deve ser informado o parâmetro ApiKey contendo a string.
Todas as requisições a API da plataforma deve conter obrigatoriamente os campos:
- ApiKey-> Código único de cada cliente.
- Cnpj -> Cnpj da empresa ao qual deseja efetuar a ação
- Dados -> Este campo só é obrigatório quando a ação desejada necessita de dados complementares para a execução.
Sua ApiKey poderá ser obtida dentro do PORTAL WEB da API no endereço: https://
URL’S DA API:
A URL DE HOMOLOGAÇÃO É: http:///homologacao/
A URL DE PRODUÇÃO É:http:///producao/
URL’S SOBRE HTTPS:
URL DE HOMOLOGAÇÃO É: https:///homologacao/
URL DE PRODUÇÃO É: https:///producao/
Exemplo de JSon
"ApiKey":"xxxapikeyhashxxx",
"Cnpj":"00.000.000/000-00",
"Dados": {
"atributo1":"valor1",
"atributo2":"valor2",
"atributo3":"valor3"
}
}