Authentification

L'API Goldarmy Guard utilise des jetons Bearer OAuth 2.0 pour authentifier toutes les requêtes. Vos clés d'API doivent être gardées confidentielles et ne jamais être exposées côté client.

Important : Ne committez jamais vos clés API dans un dépôt Git. Utilisez des variables d'environnement (.env) ou un gestionnaire de secrets.

Obtenir votre clé API

Accédez aux paramètres

Dans votre tableau de bord Admin, naviguez vers Paramètres → API & Intégrations → Clés API.

Générez une nouvelle clé

Cliquez sur « Nouvelle clé API », donnez-lui un nom descriptif et sélectionnez les permissions nécessaires (lecture, écriture, administration).

Copiez et stockez la clé

La clé n'est affichée qu'une seule fois. Copiez-la immédiatement dans votre gestionnaire de secrets ou variable d'environnement.

Format de la requête

Incluez votre clé API dans l'en-tête Authorization de chaque requête HTTP :

HTTP# Requête authentifiée vers l'API Goldarmy Guard
GET /api/v1/agents HTTP/1.1
Host: api.goldarmyguard.com
Authorization: Bearer gag_live_sk_4f8a2b9c1e3d7f6a0b5c8e2d4f7a1b3c
Content-Type: application/json
Accept: application/json

Réponse d'authentification

En cas de succès, vous recevrez les données demandées. En cas d'erreur d'authentification, l'API retourne un code HTTP 401 :

JSON{
  "success": true,
  "data": {
    "token": "gag_live_sk_4f8a2b9c1e3d7f6a0b5c8e2d4f7a1b3c",
    "expires_at": "2026-12-31T23:59:59Z",
    "permissions": ["agents:read", "shifts:write", "reports:read"],
    "organisation_id": "org_montréal_pro_4821"
  },
  "meta": {
    "api_version": "v1.4.2",
    "rate_limit_remaining": 4980
  }
}

ERREUR 401{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Token API invalide ou expiré",
    "docs_url": "https://docs.goldarmyguard.com/auth"
  }
}

SDK officiels

Librairies & SDK

Intégrez Goldarmy Guard en quelques lignes grâce à nos SDK officiels, maintenus par notre équipe d'ingénierie.

Python goldarmy-python

pip install goldarmy-guard

from goldarmy import Client

client = Client("gag_live_sk_...")
agents = client.agents.list()
print(agents)

JavaScript goldarmy-js

npm install @goldarmy/guard-sdk

import { GoldarmyClient } from '@goldarmy/guard-sdk'

const client = new GoldarmyClient({
  apiKey: process.env.GOLDARMY_KEY
})
const agents = await client.agents.list()

cURL HTTP direct

Aucune installation requise

curl -X GET \
  https://api.goldarmyguard.com/v1/agents \
  -H "Authorization: Bearer gag_live_sk_..." \
  -H "Content-Type: application/json"

Limites

Limites de débit (Rate Limits)

Les limites varient selon votre plan. Les en-têtes X-RateLimit-* sont inclus dans chaque réponse.

Plan	Requêtes / minute	Requêtes / jour	Webhooks	Burst
Starter	60 req/min	10 000 / jour	5 endpoints	100 req
Pro	300 req/min	100 000 / jour	Illimités	500 req
Enterprise	Illimité	Illimité	Illimités	Sur mesure
En cas de dépassement, l'API retourne HTTP 429 Too Many Requests avec un en-tête `Retry-After` indiquant le délai d'attente en secondes.

Documentation technique

Par où commencer ?