Architect API
Overview
The Architect API enables your team to securely access and manage Blueprint pricing logic through programmatic interfaces. This allows you to integrate Blueprint strategies and conditions directly into your internal pricing systems, revenue management tools, and automation workflows—reducing manual effort and improving consistency across your pricing ecosystem.
Instead of manually recreating or transferring pricing logic, you can retrieve, analyze, and update Blueprint components programmatically, enabling more efficient management and governance of pricing strategies.
Value
The Architect API supports modernization of pricing operations by:
Automating access to Blueprint logic
Retrieve and manage pricing strategies without manual interaction in the user interface.
Improving consistency across systems
Ensure alignment between Architect and internal systems by using a single, structured source of truth.
Enabling scalable updates to pricing logic
Update conditions and logic programmatically to support repeatable processes.
Strengthening governance and visibility
Access Blueprint metadata and logic in a structured format to support auditing, validation, and control.
How It Works
- Retrieve Data — Access Blueprints and conditions using supported endpoints.
- Analyze and Integrate — Use retrieved data within internal systems, tools, or workflows.
- Update Logic — Submit updates to Blueprint conditions using structured requests.
- Validate and Apply — ATPCO processes and validates updates to ensure data integrity.
Usage
API consumers can use the Architect API to:
- Retrieve Blueprint inventories and associated conditions
- Access detailed pricing logic for validation and integration
- Update Blueprint conditions programmatically
- Incorporate Blueprint data into internal pricing and automation workflows
- Access the most recent subscription processing times
Available APIs
| API | Description |
|---|---|
| Blueprint API | Retrieve and update blueprints and conditions for a host carrier. Supports listing all blueprints, retrieving condition details, and updating condition content. |
| Subscriptions Times API | Returns the most recent subscription load time from Architect. Allows you to confirm when Architect data was last updated before triggering downstream processes. |
Environments
| Environment | Base URL | Description |
|---|---|---|
| Production | https://pi.apis.atpco.net/architect | Live environment reflecting current Architect data. |
| Gold (Staging) | https://gold.pi.apis.atpco.net/architect | Non-production environment. Recommended for integration testing before connecting to production. |
Endpoints and Versions
For the full list of available endpoints and current API versions, refer to the API specifications:
Rate Limits
The following rate limits apply to both the Blueprint API and the Subscriptions Times API:
| Rate Limit | Burst Limit | Quota (per day) |
|---|---|---|
| 2 requests/second | 4 | 172,800 |
If you exceed these limits, the API will return a 429 Too Many Requests response. Implement appropriate retry logic with backoff in your client.
📝 If these rate limits are too low for your use case, create a ServiceNow ticket on the ATPCO Portal to request an increase.
Quick Start
Follow these steps to make your first API call:
1. Obtain your credentials
To request your Client ID, Client Secret, API Key, and default token scope URI, create a ServiceNow ticket on the ATPCO Portal.
2. Authenticate
Follow the steps on the Authentication page to obtain an access token and start making API calls.
3. Explore further
- Browse available blueprints and conditions to understand your data
- Check subscription times to know when processing occurs
- Review Definitions for domain concepts
- See Success and Error Codes for troubleshooting
Authorization
All endpoints require a valid OAuth 2.0 access token and an API key. Your client credentials are configured with the needed scope to access the APIs during onboarding—you do not need to request or manage scopes separately.
For details on obtaining and using access tokens, see the Authentication page.
For the full list of available endpoints and methods, refer to the API specifications: