Our API may be used to programmatically integrate with our referral system. All API requests require a username and key to be defined, therefore you must have a company account with us before being able to successfully make requests.
If you have any questions regarding our API, please refer to our Support Portal.
Before you begin testing the API, please note the following items:
- You cannot mix test and production data (i.e. a commission will not be triggered if a production ambassador is attempting to refer someone to a test campaign)
- Unless recurring commissions are enabled, ambassadors in the system cannot be referred again
- Ambassadors already in the system cannot be referred via the API or integration snippet at a later date to prevent "referral hijacking" of existing ambassadors/customers.
- Transaction IDs must be unique for each /event/record/ call for given campaign. Different campaigns can share the same transaction ID. If a transaction ID exists for given campaign then the call will be rejected.
- If you are using the
POSTmethod to call an API endpoint, you will need to send
Content-Type: application/jsonas a header in your request.
Ambassador has discontinued support for TLS 1.0 and 1.1 as they're no longer recommended as a secure way to connect to APIs. Our servers will refuse these connections. You will need to update the calls that are being made to Ambassador to use TLS 1.2 in order to avoid any issues on your side.