Aller au contenu principal

Informations sur l'API du projet

Chaque projet Supabase vient avec la possibilité d'interroger le contenu via une API. Supabase expose une documentation personnalisée que vous pouvez accéder en ligne.

Cette documentation vous sera utile afin de connaitre les URL à contacter, ainsi que les différentes actions HTTP possibles (GET, POST, etc.) pour ces dernières.

Obtenir votre URL de base d'API​

Toutes les requêtes d'API liées à votre projet auront la même URL de base.

  1. Utilisez le menu du projet pour aller dans l'onglet Settings img
  2. Cliquez sur Data API pour voir l'URL de base de l'API liée à votre projet img

Obtenir la clé d'API​

Il est nécessaire d'envoyer une clé d'API avec chacune de vos requêtes afin de vous identifier.

À partir de l'écran Settings, appuyez sur API Keys dans le menu principal img

Votre clé d'API publique est cette identifiée en tant que anon public.

Vous pouvez la copier facilement à l'aide du bouton copy

Accéder à la documentation de l'API​

Vous pouvez accéder à la documentation de l'API par table, c'est-à-dire par type de données.

Par exemple, si on voulait la documentation pour les projets du projet d'exemple Houdini:

  1. À partir du menu du projet, cliquez sur Table Editor img
  2. Sélectionnez une table et cliquez ensuite sur API Docs dans le coin supérieur droit. img
  3. Choisir Bash comme language puisque c'est le plus proche que nous pouvons obtenir pour le détail d'une requête HTTP à faire avec Postman. img

Nous verrons plus en détail la façon de lire ces entrées curl et les transférer dans Postman afin de faire des requêtes.