APIs


APIs
 





Authenticate a User

Who can use this feature?

Engage_-_System_Admin.png

 

Overview

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

Important Note

You must first create and authenticate the API.

Instructions

  1. Log into the site with your own 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
    partition_api_key.png
    • Note: These values will be provided by us.
  4. For the UserToken, expand Authentication
    authentication.png
    • Inside of Authentication, there are various API Calls.
  5. Select the API /api/Authentication/v1/Authenticate
    select_authenticate.png
  6. Click on the Model Schema
    model_schema.png
    • Note: This will automatically populate the userCredentials value.
      user_credentials.png
  7. Replace the string value with the proper Username and Password
    new_credentials.png
  8. Click Do It!
    do_it_.png
    • Note: This should generate an APIKey which will be the UserToken used above.
      UserToken.png
  9. With the UserToken available, you can continue building your API Integration



I'd Like to Request an Enhancement

0 out of 0 found this helpful

Updated:
Follow

Article Feedback