Search

We are excited to announce the launch of updated product names, logos, and headers within our user interfaces as part of the CivicPlus® Solution Rebranding initiative. These changes mark the first step toward creating a cohesive and seamless user experience across all solutions in our portfolio. As part of this transition, users may notice minor design updates. While the functionality you rely on remains unchanged, we are in the process of updating screenshots and other resources on our Help Centers to reflect the new branding. We appreciate your patience and understanding as we work to complete these updates.

Create and Authenticate an API

Updated: September 06, 2024 16:15

In order to create and authenticate an Application Programming Interface (API), you must have three things:

An API Key
A Partition
A valid username and password with system admin permissions on the site

The API Key and Partition are provided by Support, and the System Administrator (Admin) user will need to be created by the customer.

Important Note

By default, the user token created through authentication of username and password remains active for 90 days and must be re-authenticated again after that time.

Why System Admin Permissions?

Since the API will access information from whichever module you want to build the API for, it needs access. When you give an API to a System Admin user, you guarantee that it has the highest access level possible.

Feedback About the Article

Let us know what was helpful or not helpful about the article below.

0 comments

Please sign in to leave a comment.