Build with
BEAWRA APIs.
Explore the available service contract, make a live request and understand how to integrate with the BEAWRA platform.
A predictable integration surface.
The BEAWRA API is the integration boundary for services across the ecosystem. The current release establishes the versioned API surface and a working health endpoint. Additional resources will be published as their services become production-ready.
Only the health endpoint is currently available. Other resource groups in the roadmap are planned and are not callable endpoints.
Health check
Check whether the BEAWRA API edge service is responding. This public endpoint does not require authentication.
/v1/healthRequest
GET /v1/health HTTP/1.1 Host: api.beawra.site Accept: application/json
Example response · 200 OK
{
"status": "ok",
"service": "beawra-api",
"version": "v1"
}Try the endpoint
Send a real request to the public health endpoint from your browser.
https://api.beawra.site/v1/health{
"message": "Press Send request to call the live API."
}Authentication
The health endpoint is public. Authenticated API resources are not available yet. The planned identity architecture uses OAuth 2.0 Authorization Code with PKCE for browser applications and scoped, short-lived access tokens for API access.
Do not place private API keys in browser code or public repositories.
Future tokens will use explicit scopes, expiry and revocation.
Make your first request
Use any HTTP client that supports HTTPS and JSON.
curl -i https://api.beawra.site/v1/health
All API responses use JSON. The API is versioned under /v1. Breaking changes will be introduced through a new major version path.
More services, one API.
These resource groups are architectural targets, not available integration endpoints.