Connect

Connect to your APSO-generated APIs and databases. This section covers setting up connections, testing your API, and troubleshooting common issues.

API Connection

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


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

Getting Started

Configure your PostgreSQL connection

Database Setup

Use Swagger UI, curl, and API clients

Testing Your API

Diagnose and fix connection issues

Troubleshooting

Authentication Methods

APSO supports multiple authentication methods:

Method	Use Case	Header
JWT Bearer	User sessions	`Authorization: Bearer <token>`
API Key	Service-to-service	`X-API-Key: <key>`
Session Cookie	Web applications	Cookie-based auth

Request Format

All requests should include:


# 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" }
  ]
}