Authorization
Introduction
As a developer, you need two important pieces of information to access the API:
- Your instance id: it can be found in the Alcméon url: https://alcmeon.com/c/v3/#/{instance_id}/...
- Your application secret.
Both will be used for authentication of most API endpoints via HTTP Basic Auth:
- username: your
instance_id
- password: your application
secret
Get your application secret
You need to create a dedicated application with the right API permission(s) to generate a secret:
-
As an administrator, log into your Alcméon instance.
-
Hover in the top-left corner of the screen in the Alcméon logo:
-
Wait until the panel opens:
-
Click on the Settings wheel:
-
Click on the Applications menu item:
-
Click on the New Application button in the top-right corner:
-
Choose an explicit name for this application, select the relevant permission(s) you need to grant for its usage (for instance, to allow calls to an external sub-bot in the below example), copy your hexadecimal secret, and click on the Save button in the top-right corner.
Developer Sandbox
If you wish to setup a separate developer environment where you will be able to try out API requests without fear of impacting your existing Alcméon instance, please, contact [email protected] with the following information:
- Your name and email
- The Instance id of your production Alcméon instance
Updated about 1 year ago