Setting Up

Understanding Prefixes

Each account is created with 3 instances (live, training & test), each has a unique prefix.

  • Live: For real-time operations.
  • Training: For training purposes.
  • Test: For IT department tests, such as data exchange tests.

API Access

1. Creating API Users

  • TEST e.g. apiuser+test@domain.com
  • LIVE e.g. apiuser+live@domain.com

2. Generate Tokens for Each

  • Login, Go to the "API Settings" menu at the top right corner and create api tokens for each

User Access

The "+" Indicator

  • The "+" sign in email addresses helps distinguish between different instances.
  • Notifications and password resets sent to these addresses will be managed appropriately, ignoring the part after the "+".

User Creation

Here are a few important points to know about user creation before we continue:

  • Users created in LIVE automatically have access to both training and live.
  • Deleting a user from LIVE removes them from both training & live.
  • Users created in test only have access the test instance.
  • Users created in training only have access the training instance.

If you're ready, click and jump to

Data Exchange Information