Documentation API MyGeoNative

Documentation officielle de l'API de la plateforme IoT MyGeoNative.

Documentation utilisateur

• 📖 Documentation API complète (Français)
• 📖 Documentation Swagger

Cette documentation détaille l'ensemble des ressources disponibles, incluant :

Gestion des utilisateurs et comptes

• Account, User, Membership
• Authentification JWT
• Gestion des rôles et permissions

Gestion des balises et dispositifs

• Device, DeviceModel, AssignedDevice
• DeviceEvent (historique des événements)
• AssignedDeviceGroup (groupes de balises)

Système d'alertes

• AlertPolicy (configuration des alertes)
• AssignedDeviceTriggeredAlert (alertes déclenchées)
• AssignedDeviceTriggeredAction (actions exécutées)

Géolocalisation et zones

• Zone (zones géographiques)
• AssignedDeviceZone (historique de présence)

Balises BLE

• Tag (balises Bluetooth)
• AssignedTag (assignations de balises BLE)

Gestion de flotte

• AssignedDeviceVehicleData (données véhicule)
• VehicleData (templates de consommation)
• RideSection (trajets et statistiques)

Contrôle d'accès avancé

• AssignedDeviceGrant (permissions granulaires)
• AssignedDeviceUser (relations utilisateur-balise)
• TemporaryAssignedDeviceAccess (accès temporaires)

Fonctionnalités additionnelles

• Report (génération de rapports)
• App / AccountApp (personnalisation white-label)
• PushSubscription (notifications push)
• PrivateModeSession (mode privé)
• AuthenticationLog (logs d'audit)
• AssignedDeviceMode (historique des modes)

Spécification OpenAPI

La spécification OpenAPI complète est disponible dans deux formats :

• Documenation JSON
• Documenation YAML

Ces fichiers peuvent être utilisés avec des outils comme Swagger UI, Postman, ou tout autre client compatible OpenAPI.

Caractéristiques de l'API

Caractéristique	Détails
Format	JSON-LD (API Platform)
Authentification	JWT via Authorization header ou cookies
Base URL	https://api.geonative.app
Entrypoint	/api
Identifiants	ULID (Universally Unique Lexicographically Sortable Identifier)
Timezone	UTC
CORS	Activé
Temps réel	Mercure Hub (Server-Sent Events)

Démarrage rapide

Authentification

POST https://api.geonative.app/api/auth/login
Content-Type: application/json

{
  "username": "votre@email.com",
  "password": "votreMotDePasse"
}

Récupérer vos comptes

GET https://api.geonative.app/api/accounts
Accept: application/ld+json
Authorization: Bearer VOTRE_JWT_TOKEN

Lister vos balises

GET https://api.geonative.app/api/assigned-devices
Accept: application/ld+json
Authorization: Bearer VOTRE_JWT_TOKEN

Mises à jour en temps réel (Mercure)

L'API supporte les mises à jour en temps réel via Mercure (SSE - Server-Sent Events) :

GET https://api.geonative.app/.well-known/mercure?topic=*
Authorization: Bearer VOTRE_JWT_TOKEN

Topics disponibles

Les topics Mercure correspondent aux IRIs des ressources. Vous pouvez vous abonner à des ressources spécifiques ou utiliser * pour recevoir toutes les mises à jour autorisées.

Ressources supportant les mises à jour temps réel :

• /api/assigned-devices - Mises à jour des balises assignées
• /api/assigned-device-triggered-alerts - Déclenchements d'alertes
• /api/assigned-device-triggered-actions - Exécution d'actions
• /api/assigned-device-groups - Groupes de balises
• /api/accounts - Comptes
• /api/users - Utilisateurs
• /api/memberships - Relations utilisateur-compte
• /api/alert-policies - Polices d'alerte
• /api/zones - Zones géographiques
• /api/reports - Génération de rapports
• /api/push-subscriptions - Abonnements push
• /api/private-mode-sessions - Sessions mode privé

Exemples d'abonnement :

# Toutes les mises à jour autorisées
GET https://api.geonative.app/.well-known/mercure?topic=*

# Les Balises de votre compte
GET https://api.geonative.app/.well-known/mercure?topic=/api/assigned-devices

# Balise spécifique
GET https://api.geonative.app/.well-known/mercure?topic=/api/assigned-devices/{id}

Les mises à jour des ressources sont envoyées automatiquement au format JSON-LD.

Licence

© 2026 GeoNative. Tous droits réservés.