Visão Geral
Objetivo
Esta documentação tem como objetivo guiar nossos parceiros no que seria o nosso fluxo ideal de comunicação, dando uma visão geral da ordem e utilização de cada endpoint disponível na aplicação.
Fluxo de venda
Links de referência
Cadastrar Webhook | Exemplo pedido recebido | Aprovar pedido | Cadastrar NF | Recusar Pedido | Recusar meio de pagamento
Postman
Nos exemplos contidos nesta documentação foi utilizada a ferramenta Postman para fazer o envio das requisições nos endpoints, o download da ferramenta pode ser feito aqui.
A coleção dos endpoints disponíveis na aplicação pode ser obtida aqui.
Autenticação
O primeiro passo necessário para que nossos parceiros possam fazer a utilização dos nossos serviços é a autenticação, que utiliza o mesmo login e senha usados na plataforma. A descrição técnica de como este processo funciona pode ser encontrada aqui.
A autenticação também pode ser feita via Secret Key, a descrição técnica desse método pode ser encontrada aqui
Endpoints e URL base
Para utilizar os recursos disponíveis na aplicação é necessário adicionar o endpoint desejado ao fim da URL base da aplicação, seja para sandbox ou produção. Cada endpoint está detalhado em sua respectiva página desta documentação.
Exemplo de uso para o endpoint de listar logísticas: minha-base-url.com.br/integrator/api/v1/logistics/.
Segue abaixo as URL's base para uso em sandbox e produção respectivamente:
https://apis.sandbox.cotabest.com.br
https://apis.cotabest.com.br