Aurabase Logo
aurabasedocs
API/Realtime/S'abonner à un canal

S'abonner à un canal

GET/v1/realtime/ws

Upgrade WebSocket vers le service realtime. Les messages sont des objets JSON discriminés par un champ type — ce n'est pas le protocole Phoenix.

#
Request

Paramètres

tokenqueryREQUIS
JWT utilisateur, passé en paramètre de requête (un navigateur ne peut pas poser d'en-tête sur un WebSocket).
channelqueryOPTIONNEL
Canal à rejoindre à la connexion. Il doit être préfixé du projet : {project_id}:{topic}. Sinon, envoyez un message subscribe après ouverture.
vsn / formatqueryOPTIONNEL
Version du protocole : 1.0.0 = JSON texte (défaut), 2.0.0 = en-tête binaire de 6 octets + charge JSON.
config.postgres_changes[]body (subscribe)OPTIONNEL
Filtres CDC : event (INSERT, UPDATE, DELETE ou *, défaut *), schema, table, filter.
config.postgres_changes[].filterstringOPTIONNEL
Syntaxe colonne=op.valeur. Opérateurs : eq, neq, lt, lte, gt, gte, in, like, éventuellement préfixés de not..
config.broadcastobjectOPTIONNEL
self_broadcast (recevoir ses propres broadcasts, défaut false) et ack (accusé de réception, défaut false).
config.presenceobjectOPTIONNEL
key — clé de présence permettant de suivre un même utilisateur sur plusieurs onglets.
config.privatebooleanOPTIONNEL
Canal privé : une vérification d'autorisation est faite avant l'adhésion.
#
Notes

Messages du protocole

Info
Client → serveur : subscribe, unsubscribe, broadcast, presence_update, ping, access_token. Serveur → client : subscribed, event, pong, error, token_refreshed, broadcast_ack, presence_state.
#
Notes

Alternative SSE

Astuce
GET /v1/realtime/sse offre un flux unidirectionnel. Contrairement au WebSocket, il exige une clé API et déduit le projet de ?project_id= ou du préfixe de ?channel=.
#
Notes

RLS

Info
Les événements CDC héritent des policies RLS : un client n'est notifié que des changements sur les lignes qu'il peut lire. Le JWT est re-validé périodiquement (toutes les 5 minutes au plus) — envoyez access_token pour le renouveler sans rompre la connexion.
v1.0 · révisé 15 avr. 2026