Sign in ☰Get Started Overview
This guide walks you through creating an account, subscribing to the API, and making your first test call. Before you start, we recommend reading the Pricing and Promotions Overview to understand how the API behaves.
Step 1 — Create your account
Navigate to the portal and select Sign in → Sign up in the top right corner. Use your organizational email where possible. After submitting the form you'll receive a verification email — confirm it before logging in.
Step 2 — Subscribe to a product
Navigate to Products in the top menu and choose the subscription that fits your use case. Enter a name for your subscription and click Subscribe.
Journey – Build — for active development and functional code. Higher rate limits.
Journey – Explore — for exploring and testing the APIs. Lower rate limits.
The Armstrong Collective Integrations Team will approve your request within 24 hours. Reach out if you haven't heard back.
Step 3 — Retrieve your API keys
Your subscription keys are available when you're signed in under Profile → three-dot menu → View keys. You can also export any API in OpenAPI format from the APIs tab — compatible with Postman, Bruno, and similar tools.
Step 4 — Confirm your connection
Once your subscription is active, verify your keys are live by calling GET /journey/v1/health on the BPI Router API before calling any other endpoints. Include your subscription key in the Ocp-Apim-Subscription-Key header — a 200 response confirms your key is active.
Step 5 — Read the API overview before you build
Before integrating, read the Pricing and Promotions Overview. It covers how the two pricing endpoints behave differently, how promotional pricing is applied, and key API behaviours that will help you build a reliable integration.
Step 6 — Make your first calls
With your subscription active and your connection confirmed (Step 4), these two calls walk through the core flow end to end: find a package, then price it. Include your subscription key in the Ocp-Apim-Subscription-Key header on every call.
1. Search for Packages.
POST /journey/v1/packages/search — start with a season and a currency. We currently support CAD and USD. This returns the packages, departure dates, and service levels available for that season. From the results, note a PackageID, a DepartureDate, and a ServiceLevelID — you'll pass these into the next call.
{
"OfferPriceRQ": {
"Document": {
"Name": "Package search",
"ReferenceVersion": "21.3"
},
"Season": "2026",
"Currency": "USD"
}
}
2. Get a live price
POST /journey/v1/pricing/live — use the PackageId, DepartureDate, and ServiceLevelId from your search result, plus the occupancy for the guests you're pricing. This returns a confirmed, real-time price for that exact configuration. Use the values from your own search rather than copying fixed IDs — see the example on the live pricing API page for the full request structure, and the field-source table in the Pricing and Promotions Overview for where each field comes from.
For how the two pricing endpoints relate and when to use each, see the Pricing and Promotions Overview.
Next steps
Now that you're set up, head to the APIs tab to explore all available endpoints.