Zum Hauptinhalt springen

REST-API

Die öffentliche REST-Oberfläche verteilt sich auf drei Hosts: einer für Flags und Messaging, einer für die Event-Erfassung und einer für Session-Replay. Jeder liefert sein eigenes OpenAPI-Dokument aus.

HostServesOpenAPI
https://api.prodantix.comFlags, messaging, GraphQLhttps://api.prodantix.com/openapi.json
https://eu.api.prodantix.comEvent ingestion (EU)https://eu.api.prodantix.com/openapi.json
https://eu.replay.prodantix.comSession replay (EU)https://eu.replay.prodantix.com/openapi.json

Authentifizierung

Jede REST-Operation nimmt einen Projektschlüssel als Bearer-Token entgegen. Projektschlüssel gelten für genau ein Projekt; legen Sie niemals einen geheimen Schlüssel in clientseitigen Code.

JSON
{
  "Authorization": "Bearer <project key>"
}

Operations

MethodPathPurpose
GET/v1/flagsEvaluate every flag for a distinct id
GET/v1/flags/snapshotFetch the project's full ruleset for local evaluation
GET/v1/messagesRead a user's in-app inbox
POST/v1/messages/readMark an in-app message read
POST/v1/eventsIngest a batch of events
POST/v1/identifyIdentify a user and set traits
POST/v1/groupAssociate a user with a group
POST/v1/replayUpload a session replay chunk

Evaluate flags for a user

curl "https://api.prodantix.com/v1/flags?distinct_id=u_8f3a" \
  -H "Authorization: Bearer $PRODANTIX_KEY"

The three ingestion operations (/v1/events, /v1/identify, /v1/group) have their own reference: the Ingest API page carries the batch shape, the envelope rules and what a 202 does and does not promise.

OpenAPI-Dokumente

Jeder Host liefert seine eigenen Operationen unter /openapi.json aus. Die zusammengeführte Ansicht ist die API-Referenzseite dieser Website.