Navigate

Swagger / OpenAPI

Explore and test the full Cephable API interactively using the built-in Swagger UI.

Interactive API Explorer

The Cephable API ships with a built-in Swagger UI that documents every endpoint and lets you make live API calls directly from your browser:

https://services.cephable.com/swagger

What you can do in Swagger

  • Browse all available API endpoints with full request/response schemas
  • Authenticate with your access token using the Authorize button
  • Send live requests to create devices, generate tokens, and more
  • Inspect response bodies, status codes, and headers in real time

Getting started with Swagger

  1. Open https://services.cephable.com/swagger
  2. Click the Authorize button (🔒) at the top right
  3. Enter your bearer token: Bearer {your_access_token}
  4. Explore and execute any endpoint

To get an access token for use in Swagger, follow the Authentication guide to complete the OAuth flow and retrieve your access_token.

Key endpoints to explore

Category Endpoint Description
Auth POST /signin/token Exchange authorization code for tokens
Devices POST /api/Device/userDevices/new/{deviceTypeId} Create a virtual user device
Devices POST /api/Device/userDevices/{userDeviceId}/tokens Create a device hub token
Devices GET /api/Device/userDevices/{userDeviceId} Fetch device details

Next steps