Authenticate a User

This article will show you how to authenticate a user on an API.

Important Note:

You must first create and authenticate the API.

Who can use this feature?

System Administrator

Instructions

1. Log in to the site with your credentials

2. After you log in, type in /api after the domain's suffix

   • Example: civicplus.civicplus.com/api

3. In the site, enter your partition and apiKey fields:

   Note: CivicPlus will provide these values.

4. For the UserToken, expand the Authentication tab:

   • Inside of Authentication, there are various API Calls.

5. Select the API /api/Authentication/v1/Authenticate:

6. Click on the Model Schema:

   • This will automatically populate the userCredentials value:

7. Replace the string value with the proper Username and Password:

8. Click Do It!:

   • This should generate an APIKey which will be the UserToken used above:

9. With the UserToken available, you can continue building your API Integration