Getting Started

1. Check Service Health

Verify the API is running by hitting the health endpoint:

curl https://your-domain/health

2. Explore the API

View service status and metadata:

curl https://your-domain/api/status

3. Import Postman Collection

Download the Postman collection and import it into Postman to start testing all endpoints immediately.

4. Use the OpenAPI Spec

The OpenAPI specification can be imported into any API client or used to generate client SDKs.

Architecture Overview

This portal runs on AWS with the following architecture: