Référence

API Clicbase

Tout ce que ton site peut demander à ton projet, adresse par adresse. Les explications détaillées sont dans la documentation.

Adresse de base de ton projet

https://clicbase.com/db/<projet>

Connecte-toi pour voir tes projets, avec leurs vraies adresses dans chaque exemple.

S'identifier

Chaque appel porte une clé. Elle dit qui parle, et donc ce qui est permis.

anon

Clé anon

Publique : elle va dans tes pages. Ne voit que ce que tes règles RLS permettent à un visiteur.

session

Jeton de session

Rendu par la connexion. Identifie l'utilisateur : auth.uid() le reconnaît dans tes règles.

service

Clé service

Contourne la RLS et voit tout. Serveur uniquement, jamais dans une page.

En-têtes de chaque appel
apikey: <clé anon>
Authorization: Bearer <clé anon, OU jeton de session de l'utilisateur connecté>

Tables

Lire et écrire dans ta base, façon PostgREST. Tes règles RLS décident de ce que chacun voit.

  • GET/<table>?select=…&colonne=eq.valeur

    Lire des lignes : filtrer, trier, paginer

    anonsession
  • POST/<table>

    Insérer une ligne

    sessionselon la RLS
  • PATCH/<table>?id=eq.<id>

    Modifier

    sessionselon la RLS
  • DELETE/<table>?id=eq.<id>

    Supprimer

    sessionselon la RLS
  • POST/rpc/<fonction>

    Appeler une fonction SQL de ta base

    anonsessionselon la fonction

En détail dans la documentation →

Connexion des utilisateurs

Les comptes des utilisateurs de ton site. Le jeton rendu par la connexion est leur « clé session ».

  • POST/auth/signup

    Créer un compte (courriel et mot de passe)

    anon
  • POST/auth/login

    Se connecter : rend le jeton de session

    anon
  • POST/auth/recover

    Mot de passe oublié

    anon
  • GET/auth/user

    L'utilisateur connecté

    session
  • GET/auth/authorize/google

    Connexion avec Google

    anon

En détail dans la documentation →

Stockage

Images et fichiers, rangés en compartiments publics ou privés.

  • POST/storage/v1/object/<compartiment>/<chemin>

    Déposer un fichier

    sessionservice
  • GET/storage/v1/object/<compartiment>/<chemin>

    Lire un fichier

    aucune clésessionaucune si public
  • GET/storage/v1/render/image/<compartiment>/<chemin>?width=…

    Image redimensionnée à la volée

    aucune clésessioncomme le fichier
  • GET/storage/v1/bucket

    Lister les compartiments

    aucune clé
  • POST/storage/v1/bucket

    Créer un compartiment

    sessionservice

En détail dans la documentation →

Fonctions et temps réel

Du code serveur appelé en HTTP, et les changements d'une table reçus en direct.

  • POST/functions/v1/<nom>

    Appeler une fonction serveur du projet

    anonsession
  • WSS/realtime?apikey=<clé anon>

    Recevoir les changements d'une table en direct

    anon

En détail dans la documentation →

Courriel

Envoyer depuis ton domaine. Côté serveur seulement.

  • POST/email/send

    Envoyer un courriel

    service
  • POST/email/send-template

    Envoyer un modèle (confirmation de commande…)

    service

En détail dans la documentation →

Données Clicbase

Ce que seul Clicbase connaît de ton projet : ton crédit IA, ta consommation, tes visites.

  • POST/ai/v1/messages

    Appeler l'IA, payée sur ton crédit

    service
  • GET/ai/v1/credit?appels=10

    Ton crédit IA en euros, la dépense du projet, ses derniers appels

    servicesessionsession si peut_voir_credit_ia()
  • GET/mesures/v1

    Taille de la base, stockage, disque du forfait, visiteurs des 10 dernières minutes

    servicesessionsession si peut_voir_mesures()

En détail dans la documentation →

Afficher tes données Clicbase sur ton site

Ton crédit IA, ta consommation et tes visites ne vivent pas dans ta base : seul Clicbase les connaît. Ton site les lit en trois étapes.

  1. 1

    Déclarer qui a le droit de voir

    Une fonction SQL dans ta base, qui rend true pour les utilisateurs autorisés. Une par famille : peut_voir_mesures et peut_voir_credit_ia.

    SQL, à exécuter dans ta base
    create or replace function public.peut_voir_mesures() returns boolean
    language sql stable security definer set search_path = public as $$
      -- Exemple : les administrateurs de ton site. Adapte à TES colonnes.
      select exists (select 1 from profils where id = auth.uid() and admin);
    $$;
    revoke execute on function public.peut_voir_mesures() from public, anon, authenticated;
  2. 2

    Appeler l'adresse avec la session de l'utilisateur

    JavaScript, dans ta page
    const r = await fetch("https://clicbase.com/db/<projet>/mesures/v1", {
      headers: { Authorization: "Bearer " + jetonDeSession },
    });
    const { mesures } = await r.json();
  3. 3

    Afficher la réponse

    Réponse
    { "mesures": {
        "base":     { "octets": 9123456 },
        "stockage": { "octets": 48211000, "fichiers": 312 },
        "forfait":  { "offre": "Pro", "disque_octets": 80530636800 },
        "sites":    [ { "slug": "monsite", "visiteurs_10_min": 4, "pages_10_min": 11 } ],
        "lu_le":    "2026-10-12T22:40:00.000Z" } }
Sans règle déclarée, la réponse est un refus (403) : un projet qui n'a rien déclaré ne montre pas ces chiffres à ses visiteurs. La clé anon, publique, ne les lit jamais.

Piloter Clicbase depuis une IA

Pour qu'un assistant (Claude…) crée des projets, déploie un site ou lise tes journaux, ce n'est pas cette API mais le connecteur MCP, avec une clé de Docker ou de VPS.

Connecter une IA →