How to activate LimeCRM integration

Last updated About 1 month ago

How to activate LimeCRM integration

ref: https://docs.lime-crm.com/integration/rest-apis/start

To activate, provide BI Book your API key, your LimeCRM domain and your LimeCRM application name.

https://<yourdomain>/<application>/api/v1/

e.g. https://lime.example.com/Lime%20CRM/api/v1/

How to create API key

A valid API key is required to access any of the APIs. All API keys are associated with a user. This user will not be able to sign in using any client but the permissions set for the user (i.e. policies) will be enforced for all requests made using the associated API key.

API keys are managed through the Lime CRM Server Administration interface (LISA). Follow these steps to create an API key:

  • Navigate to Databases | Security | Users.

  • Create a new user and fill in the following information:

    • User type: must be set to API.

    • Display name: a human readable name for the user, e.g. Webform integration. This name is used for example in audit logs.

    • Username: a unique name to identify the user.

    • Groups: select any group memberships to control permissions.

  • Select the user and press the Create API key button. Press Continue to confirm. Note that any previously generated API key for the selected user will become invalid.

    • If you get an error message creating the API key, please refer to this information: https://docs.lime-crm.com/kb/10017

  • The generated API key will be shown.