Getting Started
This guide walks you from zero to your first authenticated API call.
Prerequisites
- Docker Desktop (for local development with the full stack)
- A valid RSA Platform account — contact your platform administrator or tenant admin
curlor an HTTP client of your choice
Quick Start
1. Choose your authentication method
| Your role | Auth method | Token type |
|---|---|---|
| POS vendor / machine | API Key | X-Api-Key header |
| Backend service / ETL | Client Credentials | JWT Bearer |
| Tenant admin / developer | PKCE | JWT Bearer |
2. Obtain a token
See Authentication for Getting Started for step-by-step instructions.
3. Make your first request
See First Request for hello-world examples against every API.
4. Explore the APIs
Use the API Reference for interactive documentation with live try-it functionality.
Local Development Stack
The fastest way to run the full RSA Platform locally is Docker Compose:
cd docker
docker compose up --build
This starts SQL Server, Redis, all four APIs, and the Identity server. See Environments for the full port map.