Please enable JavaScript to view this site.

EventPro Software User Manual

Breadcrumb Trail: EventPro API

User API Authorization

Scroll Prev Top Next More

In order to use the EventPro API, you need to create an API Key on your Security User in EventPro.

That API Key needs to be used and passed in all requests in the Headers under the Authorization item.

 

For example, if using Postman, under the Authorization tab, you would set the Type to API Key, the Key to Authorization, and the Value to your API Key.

 

IMPORTANT NOTE:  The Security Permissions set on the Security User determine what EventPro data you can retrieve with that User's API Key.  

If the User does not have the Security Permissions to access certain data, you will not be able to retrieve that data with that Security User's API Key.  

For example, if you request data for all Events, but you use an API Key belonging to a Security User who only has permission to access Tentative-status Events, the retrieval will only send Tentative-status Events.  

To review how to set Security Permissions, see Security Setup > Roles (Security Permissions).

 

Generate a User's API Key

1.Edit the Security User. (Review Security Setup > Users > Edit User.)

2.In the Security User edit form, click the Generate API Key button in the top ribbon.

Screenshot of Security User edit form, Generate API Key command

3.The Password dialog appears. Enter the User's login password and click OK.

Screenshot of Password dialog when generating user's API key

4.The User's API Key field will be populated. You may want to copy and save this API Key in a safe place. As noted above, this API Key needs to be used and passed in all requests in the Headers under the Authorization item.

Screenshot of Security User edit form with API Key field populated

5.Save and Close the Security User edit form.

© 2023 EventPro Software, a wholly owned subsidiary of Profit Systems Inc. All Rights Reserved.