Aptia One Developer Portal
Welcome to the Aptia One Developer Portal. This platform provides carrier partners, payroll providers, and enterprise benefit administrators with a modern, resource-oriented RESTful API, canonical OpenAPI 3.1 specifications, interactive API exploration, and strongly-typed multi-language client SDKs.
Architecture & Ecosystem Overview
The Aptia One platform abstracts internal event-driven CQRS architectures behind a clean, resource-oriented REST layer. External integration partners interact directly with pragmatic domain models:
👥 Participants & Dependents
Comprehensive census management, demographic updates, contact details, and spouse/dependent associations.
Census Ingestion Guide →📋 Enrollments & Elections
Real-time active coverage queries, qualified life event initiation, and benefit choice submission with tier validation.
Elections Guide →💰 Payroll & Deductions
Calculated employee deductions, employer subsidy extraction per pay period, and tenant frequency calendars.
Payroll Deductions Guide →📦 Multi-Language SDKs
Download pre-compiled, strongly-typed client libraries for TypeScript, Python, and C# (.NET 8) with zero contract drift.
Download Center →Two-Tier Environment Gateways
Aptia One physically isolates integration traffic by deployment gateway. The gateways this portal documents:
| Environment | Base URL | Lifecycle Mapping | Purpose |
|---|---|---|---|
| Development | https://api.development.aptiaone.com | TESTING | Preview gateway for reviewing changes in the development environment. Resolves tenants to their TESTING environment. |
External partners are completely shielded from internal database partition keys and environment UUIDs. The API Gateway and Edge Facade automatically resolve the appropriate database lifecycle state based on the gateway domain invoked. Use the Environment Switcher in the top navigation bar to toggle target environments.
Quick Navigation
- Getting Started Guide: Set up your environment, obtain test credentials, and execute your first API request.
- Authentication & Security: Detailed guide on OAuth 2.0 Client Credentials Grant, AWS Cognito token exchange, and tenant isolation models.
- Interactive API Reference: Browse all 11 RESTful endpoints using the embedded Scalar OpenAPI 3.1 explorer.
- Client SDK Download Center: Download TypeScript, Python, and C# client bundles.