Aller au contenu

Galaxie Artibox

Référence de l'API

Toutes les routes de l'API publique d'Artibox Calendar : portées, paramètres, exemples de requêtes et de réponses, erreurs.

Adresse de base
https://www.artibox-calendar.com/api/v1

Authentification

Envoyez un jeton personnel (rdv_pat_…) ou un jeton d'accès OAuth (rdv_oat_…) dans l'en-tête x-api-key. Chaque route demande une portée.

curl 'https://www.artibox-calendar.com/api/v1/me/context' \
  -H "x-api-key: $RDV_TOKEN"
Lire le guide de démarrage

Portées

PortéeDescription
utilisateur:lireLire le compte du jeton, son contexte et ses notifications
organisation:lireLire l'organisation, ses réglages et ses membres
organisation:administrerModifier l'organisation, ses réglages, ses membres et ses formulaires d'orientation
types:lireLire les types de rendez-vous, leurs créneaux et leurs messages
types:ecrireCréer, modifier et supprimer les types de rendez-vous
disponibilites:lireLire les plannings, les exceptions, les heures occupées et l'aperçu des disponibilités
disponibilites:ecrireCréer, modifier et supprimer les plannings et les exceptions
reservations:lireLire les rendez-vous et les sondages
reservations:ecrireCréer, déplacer, annuler et constater les rendez-vous ; gérer les sondages
liens:ecrireCréer des liens uniques, des liens signés et des envois de lien
webhooks:ecrireGérer les abonnements aux webhooks et rejouer les livraisons
journal:lireLire le journal d'audit de l'organisation
donnees:effacerExporter et effacer les données personnelles d'un invité (RGPD)

Limites

100 appels par minute et par jeton. Chaque réponse porte X-RateLimit-Limit, X-RateLimit-Remaining et X-RateLimit-Reset ; au-delà, 429 et Retry-After.

Erreurs

HTTPDescription
401Jeton absent, inconnu ou expiré
403Portée manquante ou droit refusé
404Introuvable (ou d'une autre organisation)
409Conflit : créneau pris ou requête en cours
422Données refusées : le détail est donné champ par champ
429Trop d'appels : attendez Retry-After
{
  "message": "error",
  "data": null,
  "errors": {
    "error": "…",
    "validation": {
      "start": [
        "…"
      ]
    }
  }
}

Compte et contexte

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

4 routes

Types de rendez-vous

Les types de rendez-vous de l'organisation, leurs réglages et leurs créneaux.

9 routes

Disponibilités

Les plannings, les exceptions et l'aperçu des heures libres des membres.

12 routes

Rendez-vous

Créer, lire, déplacer, annuler et constater les rendez-vous.

9 routes

Réunions ponctuelles

Des rendez-vous à créneaux choisis, proposés une fois à un invité.

4 routes

Liens uniques et liens signés

Les liens de réservation à usage unique et les liens signés avec contexte (11.8).

4 routes

Envoi du lien

Envoyer le lien d'un type par courriel ou SMS, et le relancer.

3 routes

Messages par type

Les messages envoyés aux invités d'un type (confirmation, rappel…).

3 routes

Sondages de dates

Proposer des dates, suivre les votes, confirmer une date.

5 routes

Organisation

L'organisation, ses réglages, ses membres, son domaine et sa clé de contexte.

20 routes

Formulaires d'orientation

Les formulaires qui orientent un invité vers le bon type ou la bonne personne.

7 routes

Webhooks

Les abonnements aux événements, leurs livraisons et leur test.

8 routes

Données personnelles

Exporter et effacer les données d'un invité (RGPD).

3 routes

Serveur OAuth

Échanger un code, rafraîchir, révoquer et inspecter les jetons d'une application OAuth.

3 routes

Serveur MCP

Le point d'entrée MCP pour les assistants et agents IA.

3 routes