Connect

Connect to your Apso-generated APIs and databases. This section is for frontend developers, backend developers, and AI assistants that need to verify a generated service behaves correctly outside the codebase.

Use these pages after generation succeeds and before you build product features on top of the API.

Effective connection workflow

1. Start the generated service locally.
2. Confirm /health responds.
3. Create one record with curl or Swagger.
4. Read it back through the generated list endpoint.
5. Add authentication and tenant headers only after the unauthenticated path works.
6. Move the same request shape into your frontend or SDK client.

API connection

Your Apso-generated backend exposes a REST API with the following structure:

https://your-api.example.com
├── /auth          # Authentication endpoints
├── /users         # User management
├── /{entity}      # Entity CRUD endpoints
└── /health        # Health check

Getting started

Authentication methods

Apso supports multiple authentication methods:

Request format

For authenticated JSON requests, include these headers:

# Required headers
Content-Type: application/json
Authorization: Bearer <your-token>
 
# Multi-tenancy header (if enabled)
X-Organization-Id: <org-id>

Response format

Successful responses:

{
  "data": { /* entity or array */ },
  "meta": {
    "total": 100,
    "page": 1,
    "limit": 20
  }
}

Error responses:

{
  "statusCode": 400,
  "message": "Validation failed",
  "errors": [
    { "field": "email", "message": "Invalid email format" }
  ]
}