API reference

The Open Network REST API — base URL, authentication, and every endpoint.

The Open Network API is a JSON REST API. It is called from your server, authenticated with an API key, and answers with a consistent response envelope.

Base URL#

https://api-host.localoy.app/api/v1/open-network/v1

Sandbox and production share the base URL; the key decides the environment. Paths below are relative to it.

Authentication#

Send your key as a bearer token. Each endpoint needs one scope.

Conventions#

JSON bodies with Content-Type: application/json, at most 1 MB.
camelCase field names; money as integers in minor units.
ISO 8601 UTC timestamps.
Errors carry a stable code.
Rate limit: 240 requests per 15 minutes per key.

Authenticated request

curl "$LOCALOY_BASE_URL/ping" \
  -H "Authorization: Bearer $LOCALOY_API_KEY"

Response · 200

{
  "success": true,
  "data": {
    "ok": true,
    "principal": "PARTNER",
    "environment": "PRODUCTION",
    "scopes": ["REGISTRATION", "UPDATE", "INVENTORY", "PAYMENT"],
    "keyPrefix": "lok_live_ab3kq7mz"
  }
}

Endpoints#

Method	Path	Scope	Description
GET	`/health`	none, no key	Service health.
GET	`/ping`	key, no scope	Verify a key.
POST	`/catalog/items`	`REGISTRATION`	Create or replace an item.
GET	`/catalog/items`	`INVENTORY`	List items.
GET	`/catalog/items/{externalId}`	`INVENTORY`	Retrieve an item.
PATCH	`/catalog/items/{externalId}`	`UPDATE`	Update an item.
DEL	`/catalog/items/{externalId}`	`UPDATE`	Delete an item.
GET	`/bookables`	`INVENTORY`	List what items can link to.
GET	`/payments/sessions/{id}`	`PAYMENT`	Retrieve a payment session.
POST	`/payments/sessions/{id}/result`	`PAYMENT`	Report a payment result.
POST	`/payments/sessions/{id}/refund`	`PAYMENT`	Record a refund.

Account setup — keys, webhook endpoints, checkout and inventory settings — is done in the Partner Portal, not through this API.