API de Parceiros v2

Seja bem-vindo(a) ao guia de como utilizar nossa API.

As APIs da Árvore seguem o padrão REST, no qual os web services armazenam e disponibilizam dados por meio de requisições HTTP.

Cada URI (também conhecida como endpoint) representa um recurso específico disponível no serviço. As requisições HTTP, como POST, GET, PUT e DELETE, permitem que a aplicação cliente crie, acesse, atualize ou exclua recursos, respectivamente, de forma padronizada.

Host base: https://livros.arvore.com.br/

Requisições permitidas

POST: Criar um recurso.
GET: Obter informações de uma lista de recursos ou um recurso específico.
PUT: Atualizar um recurso.
DELETE: Excluir um recurso.

Respostas

A API retorna uma resposta em formato JSON, com os seguintes status HTTP sendo retornados por padrão:

Resposta	Descrição
`200 OK`	A requisição foi realizada corretamente.
`201 Created`	A requisição foi realizada corretamente e o recurso criado.
`204 No Content`	A requisição foi realizada corretamente e não há nada a ser retornado.
`400 Bad Request`	A sintaxe da requisição está mal formulada ou estão faltando parâmetros requeridos na requisição.
`401 Unauthorized`	A autenticação falhou ou o usuário não possui as devidas permissões para a requisição requisitada.
`403 Forbidden`	Acesso negado.
`404 Not Found`	O recurso requisitado não foi encontrado.
`422 Unprocessable Entity`	A sintaxe da requisição está correta, porém não é possível processar as informações solicitadas.
`500 Internal Server Error`	O servidor encontrou uma condição inesperada que o impediu de satisfazer a requisição.

Codificação

Use a codificação UTF-8 ao enviar argumentos para os métodos da API.

Utilização da nossa API collection

Para utilizar nossa API via plataformas de API (recomendamos a ferramenta Postman), você pode baixar nossa coleção contendo:

principais requisições para a API da Árvore;
arquivo com variáveis de ambiente para nosso ambiente de Staging;
arquivo com variáveis de ambiente para nosso ambiente de Produção.

Download do arquivo

Importando os arquivos da collection para o Postman

Comece clicando no botão superior esquerdo Import e selecione os arquivos presentes na pasta collection_files.
Clique no botão Import para finalizar o processo.
Após importar, clique na pasta Árvore que foi criada e vá para a aba Scripts e então em Pre-request.
Nesta aba será necessário inserir a access_key e a access_key_id da conta desejada.
Salve as alterações.

Pronto, agora você poderá utilizar os endpoints normalmente.