Skip to main content

Home

Local Public Platform APIs​

The Local Public platform is comprised of multiple APIs. API consumers will generally need to be able to use the Persisted Operations (POPs) API and HTTP API to interact with the platform.

The GraphQL API is unstable and not intended for direct API consumer operations.

Persisted Operations (POPs)​

Persisted Operations (POPs) are pre-built GraphQL queries stored as named "operations".

POPs are the "canonical" versions of GraphQL operations that provide the right amount of information flexible enough to be used across all types of consumers.

HTTP API​

The HTTP API serves some specific, critical API interactions that all consumers will need to understand.

Most important among these are:

  1. API Auth for authenticated to the APIs, and
  2. Device Init for "initializing" a (end user) device on the API.

GraphQL API​

danger

The GraphQL API is unstable and may change at any time. Direct querying of the GraphQL API is strongly discouraged and may be disabled entirely in the future.

The GraphQL API is the foundational API that serves the entire Local Public platform.

The primary use case for the GraphQL API is local discovery, development, and testing for the Local Public platform and to provide detailed documentation for shared elements used by all Local Public platform APIs.

Webhooks​

Webhooks are supported for the documented events, but cannot be directly integrated by API consumers. Please open a support ticket with the Local Public team if you are interested in using a documented webhook (or have a request for a different event).