6.5 Affinitext Task API

What the Affinitext Task API?

API stands for ‘Application Programming Interface’ and allows one system to communicate with another, either within or across organisations.  It is an efficient and time-saving method of transferring high volumes of complex data and communications can be automated to be generated on a regular or on demand basis. 

The ‘Affinitext Task API’ allows your organisation’s system to request information from the Affinitext Task module. 

How do we set up the Affinitext Task API? 

1.  Identify the Task API User

The Task API User (TAU) can either be an existing Affinitext user or a new user account may be created specifically as the TAU.  In either event, the first step is to ensure that the Task permissions allow the TAU to access all the Tasks required.  

Access to the Task API data is permissions based and limited to only the Tasks which the TAU has access to in the Affinitext library.  This means that the TAU needs to be either the creator, assignee, verifier or included in the user group allocated as a collaborator of a Task to be able to access the data for that Task through API. 

2.  Create an ‘API Affinitext User’

Once the TAU has been identified, the account is upgraded from a standard Affinitext library user to a TAU user and a ‘Bearer Token’ created.  This token should be saved for future API access to the Affinitext Task module. 

The TAU can request a new bearer token at any time by logging into the Affinitext library using their library credentials and requesting a new token under the My Profile icon. 

3. Your Organisation sets up the Request

Requests to be sent directly to the URL: https://[library].affinitext.com/api/tasks, using the bearer token.  The data provided will be in JSON format.

For a printable version of this article, please download the document attached at the foot of this article.

 

Document Version Control

Article Number:                        AFHC01011
Authors:                                   Jem Fennell
Creation Date:                         28 Sep 2022
Document Owner:                   Jem Fennell
Approved by:                           Affinitext Board of Directors
Date of last review:                 19th February 2025
Reviewed by:                           Jem Fennell
Date of next review:                1st September 2025