Authentication & Authorization
The AIR MILES security layer granting access to member APIs and associated services.
Collector Service
Developer information about Collector Service API
The purpose of this documentation is to provide a guide on how to integrate with the AIR MILES Collector Service API.
As part of this documentation it’s included information on RESTful HTTPS requests/responses and error codes for each endpoint.
Target audience
This material is intended to be used by a Partner wishing to integrate with the AM Collector Service API.
What is the Collector Service API?
The Collector Service API provides REST-based services for enrolling new members and looking up the profile and summary information of existing members.
Integration environments
There are two sets of environments used by partners to integrate with the real-time checkout platform. These environments are configured similarly for consistent production-level quality, whether the partner has deployed to production or is still performing non-production testing.
| Environment | Domain | Description |
|---|---|---|
| Certification | https://cert.airmilesapis.ca | Contains production quality code and test data used for developing and testing 3rd party integrations. |
| Production | https://airmilesapis.ca | Contains production code and live user data for real-world 3rd party integrations. |
Endpoints
- Enrollment (POST): <domain>/collectors
- Summary (GET): <domain>/collectors/{collector-number}/summary
- Profile (GET): <domain>/collectors/{collector-number}/profile
Your AMRP project team
In preparation for launch, an AIR MILES team is pulled together to assist Partners with integration and setup. This team will provide the following services:
- Consulting Partners on the best technical solution to support AIR MILES Issuance based on system compatibility.
- Providing guidance for assessing Partner requirements, data exchange methods, and reconciliation.
- As well as overseeing a broad range of activities to meet the requirements of launch, including:
- Planning
- Communications
- Delivery
- Execution
- Monitoring
This section includes
Enrollment endpoint
Developer information about Enrollment endpoint of Collector Service API
Summary endpoint
Developer information about Summary endpoint of Collector Service API
Profile endpoint
Developer information about Profile endpoint of Collector Service API