Documentation Index

Fetch the complete documentation index at: https://www.civicplus.help/llms.txt

Use this file to discover all available pages before exploring further.

Use a Client to Connect to the HCMS

Prev Next

This article will show you how to use a Client to connect to the HCMS.

Who can use this feature?

Owner

Instructions

  1. Add a client to the HCMS

  2. Click the Connect button to create a temporary access token, which would be valid for the next 30 days Client configuration interface showing Client ID, Secret, and Connect button.

    Note:

    If the access token expires, a new one can be generated.

  3. Select the Connect manually optionInstructions for connecting manually with Postman or curl in the application interface.

  4. On this screen is the curl request to get the token using API, the access token, and the syntax for using the token as an HTTP header for all requestsInstructions for obtaining a token using curl in a connection setup interface.

  5. Select the copy icon for option 2 to add the access token to the clipboard or use option 1 to automatically retrieve the access token with an HTTP request using the Client ID and SecretInstructions for obtaining a token using curl and adding it to requests.

  6. Navigate to the API documentation specific to the integration you will be building