You can request a list of all or only some cases, get an overview of all the data present in a single case, see a list of all the instances of a specific ontology, and retrieve information on a specific instance.
You can also create and delete cases through the API, change the value of information fields in a case, and change the owner of a case.
Other possibilities include uploading and deleting proofs, downloading case materials (e.g. booklets), transitioning cases, and sending case booklets out via email.
Using webhooks, you can select to be notified of specific case updates in real time.
To make requests to the atfinity API, you need:
a configured atfinity tenant
an API Key to authenticate yourself to the atfinity API
Create an API Key
API keys are created in the administration screen of your atfinity application. This means you need at least admin rights for atfinity to create and manage API Keys.
The admin area is accessible by clicking on the shield icon in the lower left corner of the app. Once there, click on API Keys in the menu’s Integrations section.
Next, click 'Create API Key'. This screen will pop up:
Enter a name for your API Key, then click 'Create API-Key'.
Next, you will see a screen with the API Key that was created in bold. Be sure to copy it, so you can store and use it to authenticate yourself when making requests to the atfinity API.
You can create an unlimited number of API Keys. In the API Keys overview, click ‘Revoke’ to delete keys you no longer need.
Use an API Key
To use an API Key in your communication with the atfinity API, add it to the HTTP header of your request, with:
value: the bold value you copied when creating the key
As the key, use <Api-Key>.
As value, use the bold value you copied when creating the key.