API GraphQL

Clés API

Générez des clés API depuis Paramètres > Clés API dans l'application. Ces clés authentifient toutes les requêtes envoyées à l'API, ainsi que celles vers l'API tRPC.

Point d'accès GraphQL

Production : https://api.rolebase.io/graphql

Développement local : http://localhost:8888/graphql

L'API est propulsée par Hasura, vous pouvez donc vous référer à la documentation Hasura pour les capacités de requête avancées.

Testez des requêtes en direct dans le Playground GraphQL. Pour les procédures backend qui vont au-delà du CRUD, consultez l'API tRPC.

Démarrage rapide

Avec curl

curl -X POST https://api.rolebase.io/graphql \
  -H "x-api-key: YOUR_API_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{"query": "{ org { id, name } }"}'

Avec Apollo Client

import {
  ApolloClient,
  InMemoryCache,
  createHttpLink,
  gql,
} from '@apollo/client'

// Créer le client avec les en-têtes d'authentification
const client = new ApolloClient({
  link: createHttpLink({
    uri: 'https://api.rolebase.io/graphql',
    headers: {
      'x-api-key': 'YOUR_API_KEY_HERE',
    },
  }),
  cache: new InMemoryCache(),
})

// Exemple de requête
const { data } = await client.query({
  query: gql`
    query GetOrganization {
      org {
        id
        name
      }
    }
  `,
})

Entités

Chaque entité prend en charge les opérations GraphQL standard (requête, mutation) en fonction des permissions de votre clé API.

Organisation et membres

• org — Organisations
• member — Membres de l'organisation
• org_file — Fichiers de l'organisation
• org_subscription — Abonnements de l'organisation

Cercles et rôles

• circle — Cercles organisationnels
• circle_leader — Attributions de leadership des cercles
• circle_link — Liens entre cercles
• circle_member — Appartenances aux cercles
• circle_participant — Participants des cercles (vue)
• role — Rôles au sein des cercles

Réunions

• meeting — Réunions
• meeting_attendee — Participants aux réunions
• meeting_recurring — Configurations de réunions récurrentes
• meeting_step — Étapes et points de l'ordre du jour
• meeting_template — Modèles de réunion