ShieldGMB

Documentation API

Une API REST pour brancher ShieldGMB à vos outils : CRM, caisse, automatisations n8n / Make / Zapier.

Authentification

Les appels serveur à serveur utilisent une clé d’API créée depuis l’application. La clé n’est affichée qu’une fois : seul son empreinte est conservée.

curl https://api.shieldgmb.iprotego.net/api/v1/locations \
  -H "Authorization: Bearer sgmb_votre_cle" \
  -H "Accept: application/json"

Filtres, tris et pagination

Les collections volumineuses utilisent une pagination par curseur, stable même si des enregistrements sont ajoutés pendant le parcours.

GET /api/v1/locations?filter[status]=active&sort=-created_at&per_page=50

{
  "data": [ ... ],
  "meta": { "next_cursor": "eyJpZCI6NDJ9", "prev_cursor": null }
}

Format d’erreur

Toutes les erreurs suivent la même structure, quel que soit le code HTTP.

{
  "message": "Le champ nom de la bulle est obligatoire.",
  "errors": {
    "name": ["Le champ nom de la bulle est obligatoire."]
  }
}

Webhooks et connecteurs

Les webhooks sortants sont signés en HMAC : vérifiez l’en-tête X-ShieldGMB-Signature avant de traiter la charge utile. Un serveur MCP permet également de piloter la plateforme depuis un assistant IA.

Points d’entrée principaux
GET

/api/v1/locations

Lister les établissements
POST

/api/v1/locations

Créer un établissement
GET

/api/v1/locations/{id}

Détail d’un établissement
GET

/api/v1/dashboard

Métriques consolidées avec comparaison
GET

/api/v1/usage

Quotas et consommation de la période
GET

/api/v1/pricing

Grille tarifaire publique
L’accès API est inclus dans l’abonnement. La référence complète, générée depuis le schéma, est publiée avec l’ouverture de l’API.

Besoin d’un accès API ?

Créez votre compte, activez l’abonnement et générez une clé en quelques minutes.