REST API

Uso wa REST wa umma unaenea kwenye seva tatu: moja kwa bendera na ujumbe, moja kwa upokeaji wa matukio, na moja kwa urudiaji wa vipindi. Kila moja hutoa hati yake ya OpenAPI.

Host	Serves	OpenAPI
https://api.prodantix.com	Flags, messaging, GraphQL	https://api.prodantix.com/openapi.json
https://eu.api.prodantix.com	Event ingestion (EU)	https://eu.api.prodantix.com/openapi.json
https://eu.replay.prodantix.com	Session replay (EU)	https://eu.replay.prodantix.com/openapi.json

Uthibitishaji

Kila operesheni ya REST hupokea ufunguo wa mradi kama tokeni ya Bearer. Funguo za mradi ni za mradi mmoja tu; usiweke kamwe ufunguo wa siri katika msimbo wa upande wa mteja.

JSON

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

Operations

Method	Path	Purpose
GET	/v1/flags	Evaluate every flag for a distinct id
GET	/v1/flags/snapshot	Fetch the project's full ruleset for local evaluation
GET	/v1/messages	Read a user's in-app inbox
POST	/v1/messages/read	Mark an in-app message read
POST	/v1/events	Ingest a batch of events
POST	/v1/identify	Identify a user and set traits
POST	/v1/group	Associate a user with a group
POST	/v1/replay	Upload 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"

const response = await fetch('https://api.prodantix.com/v1/flags?distinct_id=u_8f3a', {
  headers: { Authorization: `Bearer ${apiKey}` },
});

const flags = await response.json();

final response = await http.get(
  Uri.parse('https://api.prodantix.com/v1/flags?distinct_id=u_8f3a'),
  headers: {'Authorization': 'Bearer $apiKey'},
);

response = requests.get(
    "https://api.prodantix.com/v1/flags",
    params={"distinct_id": "u_8f3a"},
    headers={"Authorization": f"Bearer {api_key}"},
)

Ingest an event

curl -X POST "https://eu.api.prodantix.com/v1/events" \
  -H "Authorization: Bearer $PRODANTIX_KEY" \
  -H "Content-Type: application/json" \
  -d '{"batch":[{"distinct_id":"u_8f3a","name":"order.completed","properties":{"amount":4200}}]}'

await fetch('https://eu.api.prodantix.com/v1/events', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${apiKey}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    batch: [{ distinct_id: 'u_8f3a', name: 'order.completed' }],
  }),
});

final response = await http.post(
  Uri.parse('https://eu.api.prodantix.com/v1/events'),
  headers: {
    'Authorization': 'Bearer $apiKey',
    'Content-Type': 'application/json',
  },
  body: jsonEncode({
    'batch': [
      {'distinct_id': 'u_8f3a', 'name': 'order.completed'}
    ]
  }),
);

response = requests.post(
    "https://eu.api.prodantix.com/v1/events",
    headers={"Authorization": f"Bearer {api_key}"},
    json={"batch": [{"distinct_id": "u_8f3a", "name": "order.completed"}]},
)

Kukubaliwa si sawa na kuhifadhiwa

Operesheni za upokeaji hujibu 202. Hiyo inamaanisha tukio limekubaliwa kuchakatwa, si kwamba limehifadhiwa. Tukio lenye muundo mbovu linaweza kutupwa baadaye katika mnyororo.

Hati za OpenAPI

Kila seva hutoa operesheni zake kwenye /openapi.json. Mwonekano ulioungwa ni ukurasa wa marejeleo ya API kwenye tovuti hii.

Anza hapa

Nguzo nne

API

Marejeleo