Chamadas de API

URL Base

O endereço base da API é divido em dois tipos de ambiente: produção e homologação. É possível acessá-los seguindo as URLs apresentadas na tabela abaixo.

Tipo de ambiente	URL
produção	https://api.greendex.info/v1
homologação	https://staging.greendex.info/v1

Autenticação e Autorização

Os recursos da API requerem autenticação e autorização.

Autenticação

O processo de autenticação na API é feito com o uso das credenciais que o usuário inseriu ao se cadastrar. Para saber mais sobre este processo consulte a documentação de login.

Autorização

A autorização na API segue o padrão OAuth 2.0 e o token de acesso está no formato JWT (JSON Web Token).

Autenticação mútua

O ambiente de produção exige autenticação mútua na camada de transporte (mTLS). Assim, ao realizar a requisição o cliente deve enviar o seu certificado para correta conexão e handshake entre as partes.

Exemplos de conexões aceitas:

curl -vk https://api.greendex.info/ping --cert client.pem

curl -vk https://api.greendex.info/ping --key client.key --cert client.crt

No ambiente de homologação o uso do mTLS é opcional, sendo TLS o padrão.

Requisições

Os recursos de dados são acessados ​​por meio de solicitações HTTP, utilizando os seguintes verbos:

Método	Ação
GET	Solicita recurso
POST	Cria recurso
PUT	Altualiza recurso
DELETE	Remove recurso

Respostas

A API normalmente retorna JSON no corpo da resposta e um código de status HTTP, porém, alguns dos recursos não retornam JSON. Confira os recursos para visualizar exemplos de respostas.

Código de Status de Resposta HTTP

Código	Descrição
200	Sucesso
400	Erro de dados enviados pelo cliente
404	Erro ao encontrar dado utilizado no cálculo do porte/preço dos kits (exemplo: cep, kits, cidade, estado, tarifa e etc)
500	Erro do servidor

Erros

Os erros das chamadas da API tem o seguinte padrão de resposta:

{
  "detail": "Descrição do erro"
}