Introdução

Resumo

Esta documentação tem o objetivo de auxiliar o desenvolvedor na integração com a API da plataforma Dezwork. Estarão descritos a seguir todos os mecanismos necessários para a implementação da integração.

A API da Dezwork foi escrita seguindo os padrões da tecnologia REST (Representational State Transfer), que é o padrão atual do mercado e da maioria das APIs da web. Dessa maneira, possibilitamos aos desenvolvedores uma integração que independe da linguagem de programação escolhida.

Metodologias

A integração pode ser realizada em dois endpoints: um para ambiente sandbox e um para ambiente de produção. Recomendamos iniciar a integração em ambiente sandbox até a finalização de todos os testes necessários. Os endpoits da API BranvoPay são os seguintes:

Sandbox

https://sandbox-api.dezwork.com/

Produção

https://api.dezwork.com/

Importante

Para envio de requisições para o ambiente sandbox da API <https://sandbox-api.dezwork.com>, deve ser utilizado o token de testes. O token de produção será inválido neste ambiente, sendo válido apenas no ambiente de produção da API. Para obtenção do token de testes, visite a seção testes.

As requisições da API serão realizadas através dos métodos HTTP. Cada um dos métodos possuirá uma responsabilidade distinta e seguirá um padrão de requisição. Os métodos utilizados na API da Dezwork são os seguintes:

Método	Utilização	Exemplo
POST	Criação de recursos	Adicionar um produto, adicionar uma categoria
GET	Consulta de recursos	Consultar dados de um produto
PUT	Atualização de recursos	Atualizar dados de uma categoria
DELETE	Exclusão de recursos	Excluir uma categoria

Os retornos da API sempre serão acompanhados dos códigos HTTP correspondentes ao resultado da requisição. O formato do corpo do retorno é JSON. Os códigos HTTP utilizados pela API BranvoPay são os seguintes:

Código	Descrição
200 - OK	Quando uma requisição obtém o retorno com sucesso
201 - CREATED	Quando uma requisição cria um recurso com sucesso Ex.: Criação de produto
400 - BAD REQUEST	Quando uma requisição possui algum problema em seus dados Ex.: Nome de produto inválido, CPF do cliente inválido
401 - UNAUTHORIZED	Problemas de autenticação
403 - FORBIDDEN	Problemas de autorização
404 - NOT FOUND	URL da requisição não for encontrada
405 - METHOD NOT ALLOWED	A URL não pode ser acessada através do método solicitado Ex.: Recurso acessível via GET tenta ser acessado via PUT

Autenticação

A autenticação na API da Dezwork é realizada através do token da conta. Em todas as requisições, o token deve ser enviado através do campo ‘Account-Token’, no header de cada operação.

Account-Token: seu_token_aqui

Envio de Dados

A API da Dezwork aceita envio de dados no tipo application/json, com exceção dos produtos e fotos, que aceitam também multipart/form-data para envio de arquivos binários. Essa informação é passada no header de cada requisição, juntamente com o Account-Token:

Content-Type: application/json

ou

Content-Type: multipart/form-data

Testes

Para a realização de testes na API Dezwork, recomendamos a utilização da ferramenta POSTMAN, disponível gratuitamente no link: <https://www.getpostman.com/>. Para mais detalhes sobre a operação de testes na API, visite a seção de testes.

Nota

A API da Dezwork trabalha com um sistema de cache para requisições em curto intervalo de tempo. Recomendamos intervalo de 1 segundo entre requisições do mesmo tipo.