Esta API implementa serviços de integração com o modelo de dados dos sistemas da APPDO.
Bem-vindo à documentação das APIs disponibilizadas pelo APPDO.
Em nossa documentação, você irá encontrar as informações necessárias para integrar às APIs da APPDO.
Seguimos padrões e boas práticas de mercado para o desenvolvimento de nossas APIs.
Abaixo, estão alguns dos padrões de APIs na APPDO.
As APIs da APPDO possuem ambientes de Sandbox e Produção.
O ambiente de Sandbox funciona como ambiente de Teste, com a utilização de dados fictícios e mockados, a fim de permitir que o desenvolvedor tenha o primeiro contato e entenda o funcionamento da API.
Atenção: por se tratarem de dados mockados, o ambiente de Sandbox irá retornar dados para efeito de testes unitários e de integração.
No ambiente de Produção, deverá ser utilizado os dados reais.
Nossas APIs seguem os seguintes princípios:
Restful
Nossas APIs estão aderentes aos conceitos de Restful sempre que possível.
Agnósticas
Nossas APIs são agnósticas à implementação, podendo ser implementada em diversas linguagens de programação.
Segurança
Nossas APIs são desenvolvidas observando todos os critérios de segurança esperados para transações financeiras e informações sigilosas de nossos clientes.
Experiência do desenvolvedor e do cliente
Nossas APIs sempre são desenvolvidas tendo como o objetivo de oferecer a melhor experiência ao desenvolvedor e ao nosso cliente.
Em nossas APIS, as respostas seguem o padrão de HTTP Status code [RFC 7231]:,
200-299 – A requisição foi recebida e executada com sucesso.
400-499 - A requisição contém um erro de sintaxe ou formatação e não pode ser realizada.
500-599 - O servidor possui um erro e não pode executar uma requisição aparentemente válida.
Nossos HTTP Status Code mais utilizados são:
200 OK
201 Created
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
405 Method Not Allowed
429 Too Many Requests
500 Internal Server Error
503 Service Unavailable
Em caso de erro das nossas APIs, será retornado um objeto JSON na seguinte estrutura:
{
"errors": [
{
"code": "{response.codigoMensagem}.{response.versaoMensagem}",
"message": "{response.textoErro}"
}
]
}
Os atributos do objeto error são:
Code: atributo obrigatório contendo o Código do erro.
Message: atributo obrigatório contendo a Mensagem do erro retornado.
A Tabela de Erro para cada API, poderá ser consultada dentro dos menu disponível para cada API.
Disponiiblizamos dois canais de suporte técnico através do email ou via WhatsAPP.