Quickstart

Get from zero to a working Andamio API call, then set up the local app template when you're ready to build a frontend.

1. Mint your Access Token

Your Access Token is your on-chain identity for Andamio. Developer registration lives on the mainnet app, so you need a mainnet Access Token — a preprod-only token can't register a developer account.

1. Go to app.andamio.io
2. Click Enter → Connect Wallet
3. Connect your wallet (mainnet network)
4. Enter an alias (permanent)
5. Click Mint Access Token and sign
6. Wait ~20 seconds for confirmation

2. Register and generate an API Key

API keys for every environment — preprod included — are managed on the mainnet app. (/api-setup on the preprod app redirects to the dashboard by design.)

1. Go to app.andamio.io/api-setup
2. Connect your wallet and sign in to the Gateway
3. Register as a developer
4. Select the network for your key — preprod for development
5. Click Generate API Key and name it (e.g., "local-dev")

3. Make your first API call

With just the API key you can read public data — no app template, no frontend, just curl. These read endpoints authenticate with the X-API-Key header alone.

List courses (this doubles as your connection test):

curl -X GET "https://preprod.api.andamio.io/api/v2/course/user/courses/list" \
  -H "X-API-Key: YOUR_API_KEY"

Responses wrap results in data with a meta block, and each item carries a source field marking whether it came from on-chain, off-chain, or both (see API Concepts):

{
  "data": [
    {
      "course_id": "dbd4f125...406bcac3",
      "course_address": "addr1...",
      "owner": "some-alias",
      "teachers": ["some-alias"],
      "source": "merged"
    }
  ],
  "meta": {}
}

Get the modules for a course:

curl -X GET "https://preprod.api.andamio.io/api/v2/course/user/modules/<course_id>" \
  -H "X-API-Key: YOUR_API_KEY"

What you can do with just an API key

The full, always-current endpoint list lives in the API Reference. These are read endpoints. For user-specific actions — enrolling, submitting assignments, claiming credentials — you authenticate the user with a wallet signature. See Authentication for the full JWT flow.

Set up the app template

Ready to build a frontend? The app template wires up Web3 login and sponsored transactions for you.

git clone https://github.com/Andamio-Platform/andamio-app-template.git
cd andamio-app-template
npm install

cp .env.example .env

NEXT_PUBLIC_ANDAMIO_GATEWAY_URL="https://preprod.api.andamio.io"
ANDAMIO_API_KEY="your-api-key-here"
NEXT_PUBLIC_CARDANO_NETWORK="preprod"
NEXT_PUBLIC_ACCESS_TOKEN_POLICY_ID="29aa6a65f5c890cfa428d59b15dec6293bf4ff0a94305c957508dc78"

npm run dev

Ready for Mainnet?

These docs use preprod (Cardano testnet) for safe development. When your app is ready for production:

1. Generate a mainnet API key at app.andamio.io/api-setup — the same portal that manages your preprod keys
2. Update .env with mainnet settings — see Environment Reference

Troubleshooting

"/api-setup redirects me to /dashboard" — You're on the preprod app. API keys are managed on the mainnet app: app.andamio.io/api-setup.

"Access Token not found" — Check your wallet is set to preprod network.

"Invalid API key" — Verify there's no trailing whitespace and the key is quoted.

"Failed to fetch" — Test the gateway: curl https://preprod.api.andamio.io/health

Build errors — Regenerate types: npm run generate:types

Next Steps