Register a live connection

POST

/pair/identity

curl --request POST \
  --url http://127.0.0.1:7700/api/pair/identity \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "identity": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef" }'

• On the box itself (the default listen address)
• From another device, with a paired device token, when BOX_LISTEN allows it

Tells the box which SpacetimeDB identity this caller holds, so the box vouches for it. After that, the answer reducer accepts approvals from that connection and records them under the caller’s name: the device’s name for a paired phone, box screen for the box’s own screen. Accepted from the box’s own screen, or from a paired device with its token. A phone can also send identity when it redeems its pairing code.

Authorizations

• deviceToken
• accessToken

Request Body^required

Media typeapplication/json

object

identity

required

The 64 hex characters of the SpacetimeDB identity, from identity.toHexString().

string

/^[0-9a-fA-F]{64}$/

Example

{
  "identity": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"
}

Responses

200

The identity the box now vouches for, and the name it records answers under.

Media typeapplication/json

object

identity

string

name

string

Example

{
  "identity": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
  "name": "My phone"
}

400

The identity is not 64 hex characters.

Media typeapplication/json

object

error

required

What went wrong

string

Example ^generated

{
  "error": "example"
}

401

Not the box’s own screen, and no paired device’s token.

Media typeapplication/json

object

error

required

What went wrong

string

Example ^generated

{
  "error": "example"
}