Visão geral da API do Gorelo - Gorelo Documentation

O Gorelo permite que você integre qualquer produto externo por meio da API do Gorelo. A API do Gorelo usa chaves de API. Inclua sua chave em cada requisição por meio do cabeçalho X-API-Key. A URL base do Gorelo depende da região que você escolheu para hospedar seus dados no Gorelo:

US
Australia

URL base: https://api.usw.gorelo.io/
Referência da API: https://api.usw.gorelo.io/swagger

Exemplos de requisições

Os snippets a seguir usando fetch do JavaScript mostram como autenticar com o cabeçalho X-API-Key. Substitua YOUR_API_KEY pela sua chave e troque a URL base pela da região que hospeda seus dados.

GET

const response = await fetch('https://api.usw.gorelo.io/your-endpoint', {
  method: 'GET',
  headers: {
    'X-API-Key': 'YOUR_API_KEY',
  },
});

const data = await response.json();

POST

const response = await fetch('https://api.usw.gorelo.io/your-endpoint', {
  method: 'POST',
  headers: {
    'X-API-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ key: 'value' }),
});

const data = await response.json();

Escopos e permissões

As chaves de API podem ter escopo definido. Se uma chave não tiver acesso a um endpoint, a API retorna 403 Forbidden.

Tratamento de erros

Erro	Significado
401 Unauthorized	Chave de API ausente/inválida
403 Forbidden	Chave válida, escopo insuficiente
429 Too Many Requests	Limite de requisições excedido

IDs de status

Ativos do agente

ID	Status
1	Installing
2	Online
3	Offline
4	Pending Delete
5	Deleted
6	Pending Client Delete
7	Client Deleted

​Exemplos de requisições

​Escopos e permissões

​Tratamento de erros

​IDs de status

​Ativos do agente

Exemplos de requisições

Escopos e permissões

Tratamento de erros

IDs de status

Ativos do agente