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

As páginas de endpoint na referência da API usam a URL base dos EUA por padrão. Se seus dados estiverem hospedados na Austrália, clique na URL base no topo da página do endpoint e selecione https://api.aue.gorelo.io.

Menu de URL base em uma página de endpoint com https://api.aue.gorelo.io selecionado

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. O escopo Documentos dá a uma chave acesso aos documentos.

Campos personalizados

Os campos personalizados nas respostas da API incluem IsSet e IsHidden. Para manter o valor de um campo personalizado fora da API, ative Ocultar valor da API para esse campo.

Histórico de importação

Quando você importa registros com um CreatedOn retroativo, o Gorelo não envia notificações nem aciona automações.

O Gorelo salva as entradas de tempo que você importa com CreatedOn como Concluídas, para que não sejam faturadas. Depois disso, você não pode alterá-las nem excluí-las pela API.

Tratamento de erros

Erro	Significado
400 Bad Request	Entrada inválida ou inesperada
401 Unauthorized	Chave de API ausente/inválida
403 Forbidden	Chave válida, escopo insuficiente
404 Not Found	O registro não existe, ou um técnico OAuth tentou modificar ou excluir um registro fora de seus grupos (chaves de API não são afetadas)
409 Conflict	A requisição entra em conflito com o estado do registro, como excluir um contrato com tempo não faturado ou tempo de Block Hours
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

Notas sobre campos e valores

Alertas

Os alertas identificam o ativo ao qual se referem com AgentAssetId, CustomAssetId ou UptimeId. Use os mesmos campos para filtrar alertas.

DeviceId e UptimeCheckId são aliases obsoletos de AgentAssetId e UptimeId. Atualize suas integrações para usar os nomes de campo atuais.

Contratos e faturas

Campos de contrato: As respostas de contrato retornam DaysUntilDue, UnitCost nos itens de linha e AutoApproveTime na linha de serviço.
Preços das linhas de contrato: UnitPrice em uma linha de contrato retorna o preço efetivamente cobrado, não o preço do catálogo.
Linhas faturáveis: POST /v1/invoices fatura linhas No charge e Non-billable com valor 0. Envie BillableStatusId 1 para as linhas que devem ser cobradas.
Impostos: Linhas de fatura e de contrato sem um TaxId recebem o imposto que o aplicativo aplicaria. Para faturar sem imposto, envie o ID da sua alíquota isenta de impostos.
Exclusão de contratos: DELETE /v1/contracts/{contractId} desativa o contrato, como o aplicativo faz, para que você possa recuperá-lo. Para arquivar um contrato em vez disso, envie PATCH com StatusId 3.

Tipos de itens relacionados de documentos

O tipo de item relacionado 4 em documentos é Agent asset. Integrações que fazem a correspondência pelo ID do tipo continuam funcionando. Integrações que fazem a correspondência pelo nome do tipo devem usar Agent asset.

​Exemplos de requisições

​Escopos e permissões

​Campos personalizados

​Histórico de importação

​Tratamento de erros

​IDs de status

​Ativos do agente

​Notas sobre campos e valores

​Alertas

​Contratos e faturas

​Tipos de itens relacionados de documentos

Exemplos de requisições

Escopos e permissões

Campos personalizados

Histórico de importação

Tratamento de erros

IDs de status

Ativos do agente

Notas sobre campos e valores

Alertas

Contratos e faturas

Tipos de itens relacionados de documentos