REST API's for integrating with the Incident, Feedback, Repairs and Improvement registers
Representational State Transfer (REST) is a software architecture that imposes conditions on how an API should work.
Logiqc's REST APIs enable you to report feedback, incidents, improvements and repairs from an external page or form such as a page on your company website or a MS Forms page on your corporate Intranet.
Examples of how you can use the API include:
- Linking a simple consumer feedback or complaints form on your company website to the Logiqc Feedback register
- Creating a simplified incident report form on your corporate Intranet for staff.
How it works
- Upon submission of a report using the API, an item is automatically created as a 'draft' item in the corresponding register.
- Designated user/s will receive an email notification alerting them to the draft item. In addition, a dashboard widget provides a clear list of drafts awaiting action along with the amount of time that has passed since they were received.
- Users access the draft form by clicking on the item in the widget or going to the Draft tabs in the registers. Once the mandatory fields are completed, the item can be fully submitted and progressed to the Manage stage in the Logiqc workflow.
Limitations to be aware of when reporting via the API
|
Limitation |
Description |
|
All items posted through the API will appear in Logiqc in a Draft state. |
The item will need to be reviewed and all mandatory fields completed before progressing the item further into the Logiqc workflow. |
|
Reduced functionality |
The functionality for the creation of related Issues or Improvements as a part of reporting the incident is not available when using the API. |
|
Business Rules will not apply |
The functionality for Business Rules for consistent reporting and to assist users to complete forms is not available when using the API. Logiqc Business Rules functionality will only apply during the reviewing of the reported item. |
|
Reporters will be anonymous |
The identity of the reporter cannot be confirmed when submitting items through the API. |
|
The API does not allow User notifications to be set. |
It is expected that the reporting item manager will elect to notify additional users if required. |
|
Reduced access control |
Limited ability to automatically assign viewing permissions until the item is submitted into the Logiqc workflow. |
Using the API
An integration engineer/web developer will use our API documentation to create and test the form you're providing to end users.
When testing is complete and the form is ready to link to your Logiqc platform, the integration engineer will require an API key. To create an API key in Logiqc:
- In Admin mode, select API keys from the left nav bar (Your account will need permission to Edit API keys).
- Complete the Name, Expiry and IP filter fields and select Apply rate limit.
Warning: API keys are 'doorways' to your platform and should be used and shared with extreme caution. In no circumstances should they be made available to the public or be discoverable via your website or any other page on the Internet.
Setting who is notified when an item is submitted via the API
Upon submission of a report using the API, an item is automatically created as a 'draft' item in the corresponding register.
An email notification is sent to specified users or email addresses. The are specified in the System Setting of the corresponding register as shown below.
