setup

Start terminal setup

Starts a setup request for a terminal or an agent that has no API key yet. Keep setup_token secret, show the person verification_url and user_code, and poll POST /v1/setup/token every interval seconds. At most 10 a minute per IP address.

post/v1/setup

Request

  • Base URL: https://phonebox.dev
  • URL: https://phonebox.dev/v1/setup
  • Auth: none required

Request body

clientstring

Response

The request. It can be confirmed for expires_in seconds.

setup_tokenstring required

The terminal's secret: send it to POST /v1/setup/token. Never show it.

user_codestring required

The code the person checks against their terminal.

verification_urlstring uri required

Where the person signs in and confirms the code.

expires_ininteger required

Seconds until the request can no longer be confirmed.

intervalinteger required

Seconds to wait between polls of POST /v1/setup/token.

Changes