Initial Steps
This article explains how to navigate the documentation and the initial steps needed to connect with the MX™ ISOAgent API.
The Boarding API is organized around REST and, is designed to have resource-oriented, predictable and easy-to-use HTTP response codes to indicate API interaction. A testing environment is provided so that, prior to working with live data, testing ca be performed to understand the requirements of making successful calls to each API resource.
To connect to, and transact with, the Boarding API, a consumer key is required. This is provided by the merchant or, if using our sandbox environment, can be obtained by creating a test account. To create a test account, visit our sandbox environment. The integrating OAuth section demonstrates how to link your consumer key with a merchant's information so you can begin building powerful apps!
- Sandbox account will be provided by the boarding team for our sandbox environment(http://sandbox.mxmerchant.com)
- Understand OAuth Authentication procedures
- Browse the available documentation, FAQ section, blogs, comment and code samples
Once a comfortable level of familiarity is established with the flow of the API you can go on to linking your consumer key to the merchant information you created on our test site. Once complete you are ready to interact with the API!
How to Use Your Credentials
We offer 2 environments, each having its own merchant interface.
- Production
- Sandbox
Each environment you wish to interact with will require its own consumer key and secret.
Implementing The OAuth Work Flow
API interaction is contingent upon the requisition of an access token. Access tokens symbolize and agreement between an application and a merchant to use the merchant's data. For a more detailed guide on how to implement the OAuth flow, see the Authentication section.
Updated 3 months ago