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

Les pages des points de terminaison de la référence de l’API utilisent l’URL de base des États-Unis par défaut. Si vos données sont hébergées en Australie, cliquez sur l’URL de base en haut de la page du point de terminaison et sélectionnez https://api.aue.gorelo.io.

Menu de l'URL de base sur une page de point de terminaison avec https://api.aue.gorelo.io sélectionné

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. La portée Documents donne à une clé l’accès aux documents.

Champs personnalisés

Les champs personnalisés dans les réponses de l’API comprennent IsSet et IsHidden. Pour exclure la valeur d’un champ personnalisé de l’API, activez Masquer la valeur de l’API pour ce champ.

Historique d’importation

Lorsque vous importez des enregistrements avec une valeur CreatedOn antidatée, Gorelo n’envoie aucune notification et ne déclenche aucune automatisation.

Gorelo enregistre les entrées de temps que vous importez avec CreatedOn comme Terminées; elles ne seront donc pas facturées. Vous ne pouvez plus les modifier ni les supprimer au moyen de l’API par la suite.

Gestion des erreurs

Erreur	Signification
400 Bad Request	Entrée invalide ou inattendue
401 Unauthorized	Clé API manquante ou invalide
403 Forbidden	Clé valide, portée insuffisante
404 Not Found	L’enregistrement n’existe pas, ou un technicien OAuth a tenté de modifier ou de supprimer un enregistrement en dehors de ses groupes (les clés API ne sont pas touchées)
409 Conflict	La requête entre en conflit avec l’état de l’enregistrement, par exemple la suppression d’un contrat comportant du temps non facturé ou du temps de banque d’heures (Block Hours)
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é

Notes sur les champs et les valeurs

Alertes

Les alertes identifient l’actif auquel elles se rapportent avec AgentAssetId, CustomAssetId ou UptimeId. Utilisez ces mêmes champs pour filtrer les alertes.

DeviceId et UptimeCheckId sont des alias obsolètes de AgentAssetId et UptimeId. Mettez à jour vos intégrations pour utiliser les noms de champs actuels.

Contrats et factures

Champs de contrat : les réponses de contrat renvoient DaysUntilDue, UnitCost sur les lignes d’articles et AutoApproveTime sur la ligne de service.
Prix des lignes de contrat : UnitPrice sur une ligne de contrat renvoie le prix réellement facturé, et non le prix du catalogue.
Lignes facturables : POST /v1/invoices facture les lignes Sans frais et Non facturables à 0. Envoyez BillableStatusId 1 pour les lignes qui doivent être facturées.
Taxes : les lignes de facture et de contrat sans TaxId reçoivent la taxe que l’application appliquerait. Pour ne facturer aucune taxe, envoyez l’ID de votre taux exonéré de taxe.
Suppression de contrats : DELETE /v1/contracts/{contractId} désactive le contrat, comme le fait l’application, afin que vous puissiez le récupérer. Pour plutôt archiver un contrat, envoyez PATCH avec StatusId 3.

Types d’éléments liés des documents

Le type d’élément lié 4 des documents est Agent asset. Les intégrations qui se basent sur l’ID du type continuent de fonctionner. Les intégrations qui se basent sur le nom du type doivent utiliser Agent asset.

​Exemples de requêtes

​Portées et permissions

​Champs personnalisés

​Historique d’importation

​Gestion des erreurs

​Identifiants d’état

​Actifs d’agent

​Notes sur les champs et les valeurs

​Alertes

​Contrats et factures

​Types d’éléments liés des documents

Exemples de requêtes

Portées et permissions

Champs personnalisés

Historique d’importation

Gestion des erreurs

Identifiants d’état

Actifs d’agent

Notes sur les champs et les valeurs

Alertes

Contrats et factures

Types d’éléments liés des documents