How to use API

To get started, the first thing is to ensure that you have the API endpoints enabled in your Ellie account. As an admin user, you cab find the API tab under Admin Tools in the left-side menu. If you do not see this Tab, the API endpoints have not been enabled - please contact support@ellie.ai to have them enabled for you!

Generating a Security Token for Ellie API calls

As an admin user, in the left side menu you can find API tab under Admin Tools.

Open

On the API Settings page, you need to Generate token. After the generation of a Token, you can click on the API documentation to see examples of the syntax for applying the Token for your organization.

Open

On this page you can:

• Give name to the token

  • Provide a descriptive name for the token that clearly indicates its purpose or where it is used.

• Regenerate existing token

  • Note: If you Regenerate the Token, anyone using the previous Token will get an error. So please communicate that the Token has been regenerated, if you choose to do it.

• Delete existing token

• Create new token

  • You can generate as manny tokens as you need.

• Create read only token

  • These tokens would not let you edit content through the API, only read the data.

Documentation: Dig in!

In order to dig in, click on the API documentation link in the API Settings page or the following link: APIPreview