A Azion API é uma RESTful API baseada em requisições HTTPS, que permite que você integre seus sistemas com a nossa plataforma de forma simples, rápida e segura.

Esta documentação técnica tem como público alvo clientes e desenvolvedores e aqui você irá encontrar instruções sobre como funciona a API e quais as funções disponibilizadas. Este documento está em constante evolução e recomendamos que você o consulte antes do desenvolvimento de sua aplicação, mesmo que já esteja familiarizado com a nossa API.

  1. Primeiros Passos
  2. Endpoints

1. Primeiros Passos

Tanto requisições quanto respostas HTTPS deverão ser formatadas em JavaScript Object Notation (JSON). Todas as requisições e respostas HTTPS respeitarão as convenções que seguem.

Base URL

A URL base da API que deve ser utilizada é:

https://api.azion.net/

HTTP Methods

Cada método HTTP define o tipo de operação que se deseja executar.

HTTP Method CRUD Coleção Inteira (ex. /items) Item Específico (ex. /items/:item_id)
 GET  Read  Consulta lista de itens de uma coleção  Consulta um item específico da coleção
 POST  Create Cria um novo item na coleção
 PUT Update/Replace Substitui uma coleção inteira por uma nova Substitui um item da coleção por um novo
 PATCH Update/Modify Atualiza parcialmente uma coleção Atualiza parcialmente um item da coleção
 DELETE Delete Deleta uma coleção inteira Deleta um item da coleção

Status Codes

O código de retorno HTTP define o status de sucesso ou falha na execução da operação requisitada.

Status Code Significado
200 OK Status geral de sucesso na realização da operação.
201 CREATED Sucesso na criação de uma coleção ou item, através dos métodos POST ou PUT.
204 NO CONTENT Sucesso na realização da operação, mas sem conteúdo para ser retornado no Body. Geralmente utilizado para operações de DELETE ou PUT.
400 BAD REQUEST Erro na requisição, tais como parâmetros inválidos, ausência de parâmetros obrigatórios ou outros.
401 UNAUTHORIZED Erro resultante da ausência do cabeçalho HTTP Authentication.
403 FORBIDDEN Falta de permissão do usuário para executar a operação solicitada.
404 NOT FOUND O recurso solicitado não existe.
405 METHOD NOT ALLOWED O método solicitado não é aplicável a URL.
406 NOT ACCEPTABLE Ausência do cabeçalho Accept na requisição HTTP ou cabeçalho contendo formato ou versão não suportados pela API.
409 CONFLICT Conflito na execução da requisição, como a solicitação de criação de um registro já existente.
429 TOO MANY REQUESTS A requisição foi rejeitada temporariamente por exceder o limite de 20 operações por minuto, Rate Limit. Aguarde 1 minuto e tente novamente.
500 INTERNAL SERVER ERROR Erro não intencional, por falha não identificada no processamento da requisição.

HTTP Headers

Todas as requisições devem ser feitas enviando o HTTP Header especificando o formato de codificação desejado para as respostas e a versão utilizada da API. A versão atual da API é a 1 e o formato é application/json.


2. Endpoints

Os endpoints definem as funções disponíveis na API.

Você deve começar pela criação de um Token em Authentication, para então poder utilizar as demais funções disponíveis.