Vue d'ensemble de l'API

Comprenez ce qui est déjà documenté pour l'API OmniLab, et par où commencer avant la publication de la référence complète.

2 min de lecture

Votre backend appelle l'API et reçoit les webhooks, tandis que les functions exécutent votre propre code sur la plateforme.

À quoi servent les outils pour développeurs

  • L'authentification de serveur à serveur avec des identifiants client (client credentials)
  • Les expériences de réservation en libre-service, comme lister ou annuler les réservations d'un participant
  • Les intégrations pilotées par les événements, via les webhooks
  • Votre propre code TypeScript, exécuté par la plateforme après un événement ou pendant l'inscription d'un contact, avec les functions
  • Les intégrations que votre Customer Success Manager active pour votre compte
Client credentials Jeton Bearer Point d'accroche Hôtes autorisés Votre backend Endpoint de jeton OmniLab Endpoints API OmniLab approuvés Événements OmniLab Abonnements webhook Votre récepteur webhook Vos functions, exécutées par OmniLab Inscription d'un contact dans OmniLab Vos systèmes ou fournisseurs Votre site ou votre app Expérience OmniLab embarquée

Ce qui n'est pas encore publié

La référence REST complète, ressource par ressource, n'est pas encore publiée dans ce centre d'aide. Ne partez pas du principe qu'un endpoint découvert ailleurs fait partie du périmètre externe pris en charge.

Traitez l'API comme un périmètre approuvé, pas comme un terrain d'exploration

Utilisez uniquement les endpoints et les flux confirmés pour votre compte. Si vous avez besoin d'une couverture API plus large, convenez-en avec votre Customer Success Manager avant de commencer le développement.

Parcours recommandé pour commencer

  1. Lisez Authentification.
  2. Notez vos hôtes API de staging et de production avant d'écrire du code.
  3. Développez le premier cas d'usage en staging.
  4. Préférez les webhooks à un polling agressif quand un autre système a besoin de mises à jour rapides.
  5. Utilisez une function quand le code doit s'exécuter sur la plateforme, et non sur votre serveur.
  6. De votre côté, placez derrière un feature flag tout ce qui n'est pas pris en charge ou pas encore publié.

Étapes suivantes

Sur cette page