Visió general de l'API de Gorelo - Gorelo Documentation

Gorelo us permet integrar-vos amb qualsevol producte extern mitjançant l’API de Gorelo. L’API de Gorelo utilitza claus API. Incloeu la vostra clau a cada sol·licitud mitjançant la capçalera X-API-Key. L’URL base de Gorelo depèn de la regió que hàgiu triat per allotjar les vostres dades a Gorelo:

US
Australia

URL base: https://api.usw.gorelo.io/
Referència de l’API: https://api.usw.gorelo.io/swagger

Exemples de sol·licituds

Els fragments següents de fetch en JavaScript mostren com autenticar-se amb la capçalera X-API-Key. Substituïu YOUR_API_KEY per la vostra clau i canvieu l’URL base per la de la regió que allotja les vostres dades.

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();

Àmbits i permisos

Les claus API es poden limitar per àmbit. Si una clau no té accés a un punt final, l’API retorna 403 Forbidden.

Gestió d’errors

Error	Significat
401 Unauthorized	Clau API absent o no vàlida
403 Forbidden	Clau vàlida, àmbit insuficient
429 Too Many Requests	S’ha superat el límit de freqüència

IDs d’estat

Actius dels agents

ID	Estat
1	Instal·lant
2	En línia
3	Fora de línia
4	Supressió pendent
5	Suprimit
6	Supressió de client pendent
7	Client suprimit

​Exemples de sol·licituds

​Àmbits i permisos

​Gestió d’errors

​IDs d’estat

​Actius dels agents

Exemples de sol·licituds

Àmbits i permisos

Gestió d’errors

IDs d’estat

Actius dels agents