Andamio API Gateway

Version: 0.5.0

The Andamio API Gateway provides a unified REST API interface for the Andamio platform, including blockchain queries (Node Backend API) and high-level platform services.

Base URL: https://andamio-api-preprod-308006323670.us-central1.run.app/api/v1 Environment: Preprod

Getting Started

Authentication Flow

To use the API, you need both a JWT session token and an API key:

1. Register an Account

Create a user account:

• Endpoint: /auth/register
• View Documentation →

2. Log In

Obtain your JWT token:

• Endpoint: /auth/login
• View Documentation →
• Save the JWT token from the response

3. Authorize with Bearer Token

In the API documentation pages, click the "Authorize" button and enter:

• BearerAuth: Bearer YOUR_JWT_TOKEN

4. Request an API Key

Get your API key (requires Bearer token):

• Endpoint: /apikey/request
• View Documentation →
• ⚠️ Important: Store your API key securely - it cannot be retrieved again

5. Complete Authorization

Click "Authorize" again and enter:

• ApiKeyAuth: YOUR_API_KEY

You're now authenticated and can test all API endpoints directly from the documentation!

API Services

Node Backend API

Query blockchain state and build protocol transactions:

• Transaction Building - Admin actions, contributor operations, course creator actions, project creator actions, student operations
• Validators - Query UTxOs and decoded datums for all protocol validators
• Protocol State - Course state, project state, global state, contributor state
• Statistics - Enrollment counts, commitment tracking, treasury history
• Aggregate Data - User information across protocol components

View Node Backend Endpoints →

Platform API

High-level queries for applications:

• Courses - Get available courses
• Treasuries - Get treasury information
• User Profiles - Get user data and usage metrics

View Platform Endpoints →

Interactive Documentation

All endpoint pages include:

• Request/Response schemas with examples
• Try it out functionality - test endpoints with your credentials
• Authentication automatically included when configured
• Parameter descriptions and validation rules

Rate Limits

Different endpoints have different rate limits based on subscription tier:

• Free tier: Basic rate limits
• Paid tiers: Higher limits for production use
• Rate limit info included in API responses