Skip to content

Developer Guide

Accurids Public API

The Accurids Public API provides developers with RESTful access to the features and functionalities of the Accurids platform. This API adheres to standard REST principles, utilizing predictable, resource-oriented URLs, and works with JSON-formatted request bodies and responses.

Accessing the API

To access and explore the Accurids Public API, navigate to https://<your-accurids-domain>/api.

Replace <your-accurids-domain> with the actual domain of your Accurids deployment. This URL directs you to the API documentation interface, where you can find detailed information about the available endpoints and how to use them.

Authentication

Authentication is required to interact with the Accurids Public API. You can obtain an API key by logging into your Accurids instance, navigating to the User Menu, and selecting API Keys. Include your API key in the Apikey header when making API requests.

Further Information

For more detailed guidance on how to use the Accurids Public API, please refer to the API documentation directly within your instance at https://<your-accurids-domain>/api.