OPES API · Preview 0.3.0

Build with OPES APIs

Discover our software catalogue and submit enquiries through documented, versioned interfaces.

OpenAPI reference Request integration access

Public enquiries

POST /api/v1/enquiries

No token required. Use a unique Idempotency-Key to prevent duplicate submissions for 24 hours. Enquiries are recorded and forwarded to our team.

Limit: 5 attempts per minute and 30 per day, per IP address.

Software catalogue

GET /api/v1/catalogue/products

Published product metadata with pagination and language selection. Requires an OAuth 2.0 token with the catalogue:read scope.

GET /api/v1/integration · integration:read

Inspect your integration identity and today’s authenticated request count.

1. Request credentials

Tell our team your application name, intended use and required scopes. Access is issued after review. Keep the client secret on your server; never embed it in browser or mobile applications.

2. Obtain a token

Server integrations use the client_credentials grant. Tokens expire after 15 minutes. Replace the placeholders below with your private credentials.

POST https://opeshealthsystems.com/api/v1/oauth/token
Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials&client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET&scope=catalogue%3Aread%20integration%3Aread

3. Call the catalogue

GET https://opeshealthsystems.com/api/v1/catalogue/products?per_page=10&locale=en
Authorization: Bearer YOUR_ACCESS_TOKEN
Accept: application/json

Limit: 60 authenticated calls per minute per client. Respect Retry-After on a 429 response. Share X-Request-ID with support when investigating a request.

Availability and support

These APIs are in preview. A public sandbox and service availability commitment are not yet offered. Private clinical APIs, OpenID Connect and delegated user sign-in are not yet available.

contact@opeshealthsystems.com · Contract and detailed responses