You can use MerciYanis' API to build scripts and applications that automate processes, integrate with external platforms, and extend MerciYanis. For example, you could use the API to triage tickets, build an analytics dashboard, or manage sensors.

Each REST API endpoint is documented individually, and the endpoints are categorized by the resource that they primarily affect. For example, you can find endpoints relating to tickets in "REST API endpoints for ticketing."

API Versions

The MerciYanis REST API is versioned. The API version name follows the format v<VERSION_NUMBER>. For example, v1.

Any breaking changes will be released in a new API version. Breaking changes are changes that can potentially break an integration. Breaking changes include:

• removing an entire operation
• removing or renaming a parameter
• removing or renaming a response field
• adding a new required parameter
• making a previously optional parameter required
• changing the type of a parameter or response field
• removing enum values
• adding a new validation rule to an existing parameter
• changing authentication or authorization requirements

Any additive (non-breaking) changes will be available in all supported API versions. Additive changes are changes that should not break an integration. Additive changes include: