April 26, 2012
Updated March 1, 2020
API Accounts allow you to create custom API users within your Platform. In order to create an API user, just go to Settings > Accounts & Permissions. Once there, just click on the API user tab“Add API User” in order to create a new user account.
Fill out the fields and click Save
API USER FIELDS
Username - create a username for the API User
Company Contact - This will be the name of the Third party company or the name of the individual receiving API access
Email - The Email Address for the API user
Phone - The Phone Number for the API User
Department - Select the Appropriate Department for the API User
Description - For Internal purposes: this will help you identify your API users better
*NOTE*- Please keep in mind that if you see the message "This order was placed by unlinked API user", it just means that the user has not been updated to include the newly added user data fields. The API account access/functionality hasn't changed, we just can't pull full reports on that user's API calls. Adding this additional information will allow for more meaningful analysis of API activity.
For API accounts that you have already created, you can search for them by Id or a list of Id’s by entering the search criteria in the search field. The system will automatically populate the results for you once the search criteria is entered.
The API Accounts page will be available to users who are assigned to the administrator and technical departments within your system. An API password will automatically be generated by the system once a username is created for your API user. The API username and password that is generated can then be used in conjunction with our Transaction and Membership API. There is no limit on the number of API users that can be created in your system.
API Account Permissions
When you edit the permissions for an API user, the API Account Permissions page will allow you to enable or disable API methods for an API user. Examples of the permissions that can be set within our Transaction and Membership API are listed below.
Campaign Permissions
On the API Account permissions page, you have the ability to restrict or allow certain campaigns for your API Users; just select edit next to campaign permissions in order to set these permissions.
Third Party API Accounts
These will appear in your API Accounts page only. If you are using certain third party providers that require API access from you to post back into your system; for instance, Order Confirmation Providers among others. If you are not using any of these providers, the Third Party API Accounts will not be listed in your system.
These accounts will automatically be created by the system once the third party provider is enabled. These cannot be edited on your end; however, anytime you reset your master API account, the Third Party API Accounts will automatically be reset as well, and you will just need to update your third party provider with the new credentials.
To access your Third Party API Accounts, you will need to go to the 'Actions' drop-down menu and select 'Third Party API Credentials' as shown below. Once clicking on 'Third Party API Credentials', a box will pop up with all of your Third Party Credentials.