GCXONEDocumentation

Genesis API Aperçu

Sur cette page
  1. URL de base
  2. Authentification
  3. Ressources
  4. Conventions

La plateforme Genesis expose une API REST via HTTPS. Chaque Demande est effectuée sur une URL de base, authentifiée avec un jeton dans un en‑tête de Demande, et renvoie du JSON.

URL de base

text
https://api.nxgen.cloud/api/v1

Chaque chemin sur ces pages est relatif à celle‑ci : GET /user/me signifie GET https://api.nxgen.cloud/api/v1/user/me.

Authentification

Les Demandes portent un jeton dans le auth-token en‑tête. Voir Authentification pour savoir comment en obtenir un.

Ressources

Ressource

Opérations

Utilisateur

6

Compte

11

Site

19

Appareil

8

Capteur

9

Contrôles Caméra

6

Événement

4

Recherche d'événement

1

IO

7

Déclencheur

2

Proxy

1

Service de stockage

4

Analytique

4

Vue d’état

2

Blog

6

Contact

4

Tableau de bord

1

Dossier

6

L'intégration

6

Audit

5

Modèle de rapport

3

Rapport

8

Planification

2

Demandes de service

6

Onglet Demande de service

2

Outils développeur

1

Conventions

  • Les paramètres de chemin sont écrits entre accolades, /site/{id}. Remplacer l’ensemble du paramètre, accolades incluses.
  • Les corps de requête sont en JSON sauf indication contraire d’une opération. Sur ces pages, un corps est présenté sous forme de squelette : les noms de champs avec le type attendu à la place de chaque valeur, et (required) sur les champs qui doivent être présents.
  • Les tableaux de réponse répertorient chaque statut déclaré par la spécification. 401401 signifie que le jeton était manquant ou rejeté ;403403 signifie qu'il était valide mais non autorisé à accéder à la ressource.

Version de la spécification 1.0.0.

Cette page vous a-t-elle été utile ?

Merci — votre retour est transmis à l’équipe responsable de cette page.