🔍Características gerais

💻Formas de uso da API

A API pode ser utilizada das seguintes formas:

Integração direta do comércio com a API mediante desenvolvimento de software próprio, em tecnologia e linguagem de programação a escolha, utilizando a documentação fornecida, e atentando aos requisitos de segurança.
Integração via SDKs disponibilizadas nas tecnologias .NET (C#), Java, PHP, NodeJS (Javascript/Typescript) ou Python. Notar que as SDKs já realizam todos os tratamentos necessários, incluindo os requisitos de segurança (OAuth2/criptografia AES128) e permitem o desenvolvimento mais rápido da integração.
Plugins para integração dos sistemas de e-commerce Magento e Prestashop, que já possuem todo o código necessário para a integração, necessitando tão somente da configuração do módulo.

🚦Status de Retorno

Estamos tornando o padrão do retorno das APIs mais alinhado com o padrão REST (api 2.0), então será retornado um status diferente de 200 para erros e tratamentos de exceções do usuário com relação à conteúdo submetido.

Na tabela a seguir está detalhado o http status retornado e uma descrição detalhada da causa/origem de erros e ou confirmações de sucesso da transação.

método	Status	Descrição
BadRequest()	400	Quando houver conteúdo inválido na requisição ou regras de negócio não satisfeitas de acordo com os parâmetros
Conflict()	409	Quando o resultado da operação gerar um conflito interno de acordo com regras de negócio
Created()	201	Conteúdo criado sem necessidade de retorno do resultado que foi criado, sendo apenas uma confirmação
InternalServeError()	500	Um erro interno ocorreu durante a execução do processo, alguma exceção foi lançada e interceptada no servidor
NotFound()	404	Um recurso necessário para a operação não foi encontrado
OK()	200	Operação realizada com sucesso com ou sem retorno descritivo (em geral estrutura JSON)
Unauthorized()	401	Quando credenciais de acesso não foram validadas com sucesso e requerem uma nova validação