Quickstart

Four calls, about five minutes. Every call is also in the API reference, where you can send it from the playground.

Get your test keys

Your Dizplai contact sends a test publishable key and a test fan token. Test keys only see a test organisation’s experiences, so nothing you do reaches a live show. In the playground, put the key in x-api-key and the fan token in Authorization.

export DIZPLAI_KEY=...
export FAN_TOKEN=...

List live experiences

curl https://api.dizplai.com/v1/experiences \
  -H "x-api-key: $DIZPLAI_KEY"

Lists return live experiences unless you ask for other statuses.

Get one experience with its widgets

curl https://api.dizplai.com/v1/experiences/exp_01JBX7Q2T8M4K9R6V3N5P0WZCD \
  -H "x-api-key: $DIZPLAI_KEY"

items holds every widget in display order. Pick a live poll, and note its id and one option’s id.

Cast a vote

curl -X POST https://api.dizplai.com/v1/polls/pol_01JBX7Q3A1B2C3D4E5F6G7H8J9/votes \
  -H "x-api-key: $DIZPLAI_KEY" \
  -H "Authorization: Bearer $FAN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"option_id": "opt_01M7WQND9RKTH6WF72R2VFKZ1S"}'

202 Accepted: the vote is queued, and counts once for this fan.

Fetch the results

curl https://api.dizplai.com/v1/polls/pol_01JBX7Q3A1B2C3D4E5F6G7H8J9 \
  -H "x-api-key: $DIZPLAI_KEY"

Each option carries votes and percent, and total_votes counts the fans who voted. Your vote shows within a second, if the poll’s results_visibility lets fans see results now. See Live updates.

Next: draw the widgets in your app with the rendering guide.

Introduction

Guides