API Profiles: how to set up a User or CRM API

Control > Settings > API Profiles > (Add/Edit)

Click on the Add button:

- and fill out the necessary fields.

Fields:

• Name: Enter the Name that you wish to call this API Profile
• Allow CRM API Access: Tick this box to allow CRM API access
• Allow User API Access: Tick this box to allow User API access
• Zone: Select the Zone where this API will apply
• Allowed IPs: Enter a comma separated list of allowed IP addresses
• API Contact: Select who will be set as content creator
• Allowed Security Groups: Select one or more user security groups who can authenticate through this API (i.e. the end users)
• Allowed API Methods: Select the functions / methods this API call will be able to access
• Token Expiration Period: Enter the number of days, between 1-60 days, for the token to expire. Users will need to re-authenticate after this period. Default is 15 days (Note: Increasing the period will increase the security risk and may impact on performance of the site)
• Return Content Security Rights: Select to return the Content Security Right codes for a user (Note, if ticked, there may be performance and security implications)
• Active: Tick this box to make this API profile active

Control > Settings > API Profiles > API Profile User Help

If you need further information regarding the User API then please consult the API Profile User Help screen.

Here you will find information regarding:

• Security
• Signature Calculations
• Example Error Responses
• Example POST and GET methods for returning and writing data

Control > Settings > API Profiles > API Profile > API Profile User Test Tool

You also have at your disposal the API Profile User Test Tool.

This screen help you test your GET, PUT, POST and DELETE methods: