Aller au contenu

Galaxie Artibox

Compte et contexte · Référence de l'API

Le compte du jeton, son organisation, ses droits et ses notifications.

Lire le compte du jeton (userinfo OAuth)

GET/users/me

Portée : utilisateur:lire Lire le compte du jeton, son contexte et ses notifications

Le compte au nom duquel l'appel agit, son organisation, son rôle et les portées du jeton. Jeton : portée `utilisateur:lire`. Sert aussi de « userinfo » pour une application OAuth.

Exemple de requête
curl -X GET 'https://www.artibox-calendar.com/api/v1/users/me' \
  -H "x-api-key: $RDV_TOKEN"

Réponses

  • 200 Réussi
  • 401 Jeton absent, inconnu ou expiré
  • 403 Portée manquante ou droit refusé
  • 404 Introuvable (ou d'une autre organisation)
  • 422 Données refusées : le détail est donné champ par champ
  • 429 Trop d'appels : attendez Retry-After

Lister les notifications du compte

GET/notifications

Portée : utilisateur:lire Lire le compte du jeton, son contexte et ses notifications

Exemple de requête
curl -X GET 'https://www.artibox-calendar.com/api/v1/notifications' \
  -H "x-api-key: $RDV_TOKEN"

Réponses

  • 200 Réussi
  • 401 Jeton absent, inconnu ou expiré
  • 403 Portée manquante ou droit refusé
  • 404 Introuvable (ou d'une autre organisation)
  • 422 Données refusées : le détail est donné champ par champ
  • 429 Trop d'appels : attendez Retry-After

Marquer ses notifications comme lues

POST/notifications/read

Portée : utilisateur:lire Lire le compte du jeton, son contexte et ses notifications

Création : l'en-tête Idempotency-Key évite un doublon pendant 24 heures.

Paramètres

NomOùTypeObligatoireDescription
Idempotency-Keyen-têtestringnonUne clé de votre choix (255 caractères au plus) : rejouée dans les 24 heures, la même requête rend la première réponse sans rien recréer ; en cours, 409 ; sur une autre route, 422.

Corps de la requête

`{ids?: [uuid]}` — sans liste, toutes

Exemple de requête
curl -X POST 'https://www.artibox-calendar.com/api/v1/notifications/read' \
  -H "x-api-key: $RDV_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)"

Réponses

  • 204 Fait, sans contenu
  • 401 Jeton absent, inconnu ou expiré
  • 403 Portée manquante ou droit refusé
  • 404 Introuvable (ou d'une autre organisation)
  • 409 Conflit : créneau pris ou requête en cours
  • 422 Données refusées : le détail est donné champ par champ
  • 429 Trop d'appels : attendez Retry-After

Lire le compte, l'organisation courante et ses droits

GET/me/context

Portée : utilisateur:lire Lire le compte du jeton, son contexte et ses notifications

Exemple de requête
curl -X GET 'https://www.artibox-calendar.com/api/v1/me/context' \
  -H "x-api-key: $RDV_TOKEN"

Réponses

  • 200 Réussi
  • 401 Jeton absent, inconnu ou expiré
  • 403 Portée manquante ou droit refusé
  • 404 Introuvable (ou d'une autre organisation)
  • 422 Données refusées : le détail est donné champ par champ
  • 429 Trop d'appels : attendez Retry-After