::menu_book::Supporting Documents

Supplemental technical documentation to our guides that dive deeper into concepts.

Pick the topic that matches what you're building. Each guide covers detailed definitions and code examples.

::verified_user::Organizations

Organizations

Create, update, read, list and delete Organizations, and manage Organization user roles.

Read the guide

::bluetooth::Sites

Create, update, read, list and delete Sites, and manage Site user roles.

Read the guide

::tune::Integrations

Authorize an Integration to an Organization and enable or disable it for a Site.

Read the guide

::corporate_fare::Client Authentication

How clients, federation, auth tokens, platform roles and permissions work.

Read the guide

::location_on::Webhooks

Configure webhooks and the event notifications YP sends to your backend.

Read the guide

::hub::Architecture

The YP resource hierarchy and the three architecture models to choose from.

Read the guide

::menu_book::Device Traits

Which settings and actions each device trait offers.

Read the guide

::menu_book::Device Settings

Configure device settings, credentials, schedules and No Tour, plus bulk data file schemas.

Read the guide

::menu_book::Device State

Check action status, read device state and get device notifications.

Read the guide

::menu_book::Graph API

The GraphQL endpoint: authentication, schema, rate limits, errors and pagination.

Read the guide

::menu_book::Devices Operations

Operate a device over Wi-Fi and transfer device ownership.

Read the guide