Get Started
MyAlice provides REST APIs and Webhooks for you to build on top of MyAlice and connect your internal systems with MyAlice as well.
REST APIs and Webhooks are available in Business and Enterprise Package.
Authentication
Any API request needs to have X-Myalice-Api-Key
in the header.
Obtaining the Key
To obtain your authentication key, navigate to your Team Settings in the dashboard. Locate the API Key and store it.
Using the Key
Add X-Myalice-Api-Key
in the header of your API call. All API requests must be made over HTTPS.
- Calls made over plain HTTP will fail.
- Any request without
X-Myalice-Api-Key
in the header will also fail.
Key Security
Key Regeneration: In the event of a security breach or if you suspect your key has been compromised, regenerate a new key immediately. Contact Support for this.
Authentication Process
Once you have your API key, include it in the HTTP header of your requests under X-Myalice-Api-Key
as specified in the API documentation. The header should look like this: