Aperçu de l'API Gorelo - Gorelo Documentation

Gorelo vous permet de vous intégrer à n’importe quel produit externe grâce à l’API Gorelo. L’API Gorelo utilise des clés API. Incluez votre clé dans chaque requête via l’en-tête X-API-Key. L’URL de base de Gorelo dépend de la région que vous avez choisie pour héberger vos données dans Gorelo :

US
Australia

URL de base : https://api.usw.gorelo.io/
Référence de l’API : https://api.usw.gorelo.io/swagger

Exemples de requêtes

Les extraits JavaScript fetch suivants montrent comment s’authentifier avec l’en-tête X-API-Key. Remplacez YOUR_API_KEY par votre clé et remplacez l’URL de base par celle de la région hébergeant vos données.

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

Portées et permissions

Vous pouvez limiter les clés API par portée. Si une clé n’a pas accès à un point d’extrémité, l’API renvoie 403 Forbidden.

Gestion des erreurs

Erreur	Signification
401 Unauthorized	Clé API manquante ou invalide
403 Forbidden	Clé valide, portée insuffisante
429 Too Many Requests	Limite de débit dépassée

Identifiants d’état

Actifs d’agent

ID	État
1	Installation
2	En ligne
3	Hors ligne
4	Suppression en attente
5	Supprimé
6	Suppression de client en attente
7	Client supprimé

​Exemples de requêtes

​Portées et permissions

​Gestion des erreurs

​Identifiants d’état

​Actifs d’agent

Exemples de requêtes

Portées et permissions

Gestion des erreurs

Identifiants d’état

Actifs d’agent