Welcome to our Help Center

How does the XML API Feed Work?

The XML API allows managers and developers to retrieve data from MyAffiliates in bulk or through automated processes and scripts. The API provides a range of functions that accept input parameters and return the requested data in XML format.
The API supports both GET and POST requests, depending on the specific API function being used.
To access the available XML API functions and documentation, navigate to:
Reporting > XML APIs
Note: Access to the XML API requires separate valid manager credentials for the MyAffiliates Admin system.


The main XML API feeds available in MyAffiliates by default include the following:


Feed 1 - User Feed
Returns a list of affiliates based on the specified input parameters and filters. Eg. Status


Feed 2 - User Detail Feed
Allows specific user detail fields to be retrieved or updated for selected users. It can also be used to retrieve a specific user detail field for an individual user.


Feed 3 - User Status Feed
Returns the status of a selected list of users. It can also optionally be used to update the status of those users.


Feed 4 - Decode Token
Allows one or more tracking tokens to be decoded.


Feed 5 - Encode Token
Generates a list of tracking URLs and tokens for a specific user and selected links.


Feed 6 - User Transactions Feed
Returns one or more user transactions, with each transaction provided as a separate node. The feed can also be used to update selected details within the specified transactions.


Feed 7 - Email Match-Up Tool
Returns a list of users associated with specified media and setups. The output can include the JavaScript and HTML code for the selected media, along with the user's email address, username, and user ID.


Feed 8 - Create Player
Facilitates the creation of a new customer/player in MyAffiliates.


Feed 10 - Customer Feed
Returns customer records based on specified search criteria.


Feed 13 - Create Campaign
Allows campaigns to be created for an affiliate.


Feed 14 - Create Landing Page
Allows landing pages to be created in MyAffiliates.


Feed 15 - Offline Codes

Returns a tracking token associated with an offline code when the CODE parameter is supplied. If no code is supplied, the feed can return a list of available offline codes without their associated tokens.
Note: Tokens associated with inactive offline codes or codes with expired end dates may still be returned. It is the client's responsibility to determine whether an offline code should be accepted or honoured.


Feed 16 - Media Feed
Allows media to be created and updated.


Feed 17 - View Campaigns
Returns information about campaigns (trackers) configured within MyAffiliates.


Feed 20 - Media Details
Returns detailed information about media configured within MyAffiliates.


Feed 22 - Remapped Players
Returns players who have been remapped between the specified From Date and To Date.


Feed 25 - Affiliate Earnings
Returns affiliate earnings data based on the specified parameters.


Feed 26 - Affiliate Account Creation
Facilitates the creation of new affiliate accounts. It can create either shell accounts, where configured, or full affiliate accounts.


Feed 27 - Transaction Creation (Manual and Administrative)
Allows the creation of specific transaction types, including:

  • Manual Payment Issued transactions
  • Administrative Adjustment transactions

Detailed documentation on how to operate each Feed can be obtained from: Reporting > XML APIs


 

Was this article helpful?

Yes No

Thank you for your feedback!

×
Select company

You are related to multiple companies. Please select the company you wish to login as.