Skip to main content
Welcome to the CA Colombia API — the backend service powering the CA Colombia roleplay platform. This documentation covers everything you need to integrate with the API: authenticating users, managing characters, handling an in-game economy, operating banks, and receiving real-time events over WebSocket.

Quick Start

Make your first API call in minutes — authenticate and retrieve a user profile.

Authentication

Learn how cookie-based sessions and OAuth work with Discord and Roblox.

API Reference

Full reference for every endpoint: requests, responses, and error codes.

WebSocket Guide

Subscribe to real-time events for users and characters.

What the API Provides

The CA Colombia API is organized around a set of core resources. Each resource maps directly to a feature in the platform:

Users

Linked Discord and Roblox identities for every player.

Characters

In-game personas with biographical data, IDs, and approval workflows.

Economy

Per-character wallets tracking cash and bank balances.

Banking

Create and manage banks and multi-account banking systems.

OAuth

Authenticate players via Discord or Roblox using an OAuth 2.0 flow.

Permissions

Role-based access control governing what each caller can do.

Getting Started

1

Connect your accounts

Authenticate via the Discord or Roblox OAuth flow to obtain a session. See the OAuth Flow guide for step-by-step instructions.
2

Create a character

Use POST /v1/users/{userId}/characters to create your first in-game character. The character starts in draft status.
3

Submit for approval

Call POST /v1/users/{userId}/characters/{characterId}/submit to send the character to staff for review.
4

Go live

Once a staff member approves the character, the wallet activates and the character is ready to interact with the economy and banking system.
All API calls require a valid session cookie. See the Authentication page to understand how sessions are issued and refreshed automatically.