Logiqc API

REST API's for integrating with the Incident, Feedback, Repairs and Improvement registers

An API (Application Programming Interface) is a method for allowing applications to communicate with each other, using a set of rules and protocols. They are used to achieve  defined results. For example, the Logiqc API's are specifically designed to create records in the Logiqc platform in the Incidents, Feedback, Repairs and Improvement registers.    

API vs Integration

APIs are a fundamental building block of integrations, however, an integration is a broader concept that encompasses the entire process of connecting systems. Integrations are also often pre-designed to manage a two way flow of information between two applications. API's, on the other hand, typically play just a single role within a broader integration.   

Examples for integrating external forms and systems with Logiqc

Logiqc's REST APIs enable you to report feedback, incidents, improvements and repairs from an external form.

The following examples outline various methods for connecting your company's external forms and platforms directly to Logiqc registers, streamlining data capture and incident reporting:

Consumer Feedback & Complaints

• Website Feedback Form: Integrate a consumer feedback or complaints form from your company's public website directly with the Feedback register in Logiqc. This allows for direct submission of customer input.
• Anonymous Reporting: Enable anonymous consumer feedback or complaints submitted via your company website to flow into the Feedback register in Logiqc, ensuring privacy while still capturing valuable insights.

Staff Incident Reporting

• Custom Forms (e.g., Microsoft Forms): Link a custom digital form (like a Microsoft Form) to the Logiqc Incidents register, enabling staff to easily report incidents.
• Intranet Page: Connect a dedicated page on your company's intranet to the Logiqc Incidents register, providing a centralized and accessible way for staff to log incidents.
  
  System-Wide Integrations
• Platform Integration: Implement comprehensive integrations with other key company platforms, such as patient or client management systems, to ensure seamless data flow into relevant Logiqc registers.

Steps for implementing an API

Logiqc's APIs are built using the widely recognised industry-standard coding architecture known as Representational State Transfer (RESTful). To utilise these APIs, technical software coding skills are required. Typically, you will engage a software engineer sometimes called an 'Integrator' to do this work. 

Step 1: Planning and Preparation

1. Define your integration goals:

   • What specific data do you need to send from your external form to Logiqc (eg. feedback details, incident type, reporter contact information)?

   • Which Logiqc register will this data populate (eg. Feedback, Incidents, Improvements, Repairs)?

   • What fields in your external form map to which fields in Logiqc? (This is crucial for data consistency). 

   • Do you need to handle anonymous submissions, or will user identification be part of the integration?

2. Understand Logiqc API capabilities:

   • Review Logiqc API Documentation with your Integrator: Your Integrator can access all the information needed to build the integration here: apidoc.logiqc.com.au/.  

Step 2: Development 

1. Choose Your Integration Method/Language:

   • Direct API Calls: You'll write code in a language like Python, JavaScript (Node.js), PHP, Ruby, etc., to make HTTP POST requests to the Logiqc API.

   • Integration Platforms (iPaaS): For more complex scenarios or if you prefer a low-code/no-code approach, consider platforms like Zapier, Microsoft Power Automate, or other iPaaS solutions that can connect forms to APIs. This can abstract away some of the direct coding.

2. Design Your External Form:

   • Create your web form (e.g., HTML form, MS Form, WordPress form, etc.) with fields that correspond to the data points you identified in step 1.

   • Implement client-side validation to ensure data quality before submission.

3. Implement the API call logic (for the Integrator):

   • Consider: Data Mapping, Authentication, HTTP Requests, Error Handling, and Success Handling.

Phase 3: Testing

1. Development Environment Setup:

   • Work in a development or staging environment first. Do NOT test directly on your live Logiqc platform or production website.

   • Obtain access to the Logiqc test platform. 

   • Test API calls with tools like Postman. 

2. Unit Testing:

   • Test individual components of your code, such as the data mapping logic and the API call function, in isolation.

3. Integration Testing:

   • Submit test data through your external form and verify that it correctly populates the Logiqc register.

   • Test edge cases: missing required fields, invalid data types, large amounts of text, special characters.

   • Test successful submissions, as well as scenarios that should trigger errors (e.g., invalid API key if you were to simulate it).

4. Security Testing:

   • Ensure your API key is stored securely and not exposed on the client-side of your website.

   • Consider protecting your form submissions from spam or malicious input.

Phase 4: Deployment and Monitoring

1. Deployment to Production:

   • Once thoroughly tested in a staging environment, deploy your integration to your production environment.

   • Ensure your API key is correctly configured for the production environment.

2. Monitoring:

   • Implement logging for all API interactions (requests, responses, errors) to help with debugging and auditing.

   • Set up monitoring tools to track the health and performance of your integration. This can alert you to any issues (e.g., failed API calls, latency) in real-time.

   • Regularly review Logiqc's API documentation for updates or changes that might impact your integration.

By following these steps, you can build a robust and reliable integration between your external forms and your Logiqc platform, streamlining your data capture and management processes.

What happens when items are reported using the API?

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

• Items created via the API will appear in Logiqc in a Draft state.
  When reports are submitted via the API they do not move directly to the Manage stage, instead they are created as draft items in Logiqc. This is because a customised external form may not include all the required fields Logiqc needs to submit the item into the workflow. The item will need to be reviewed and all mandatory fields completed before progressing the item further into the Logiqc workflow.
• Business Rules will not apply
  Business Rules for reporting will not apply to an external form being completed by a staff member. Business Rules will only be applied when submitting the draft report into the workflow. 
• Reporters will be anonymous
  Logiqc is not able to detect the identity of users when they are submitting an external form via the API. This means that users reporting items will be unauthenticated and their name and position will not automatically appear in the report. 
• Reduced user support
  Only licenced users can access the platform and submit support requests to the Logiqc help desk. 
• Reduced access control
  Limited ability to automatically assign viewing permissions until the item is submitted into the Logiqc workflow.
• Reduced functionality
  Only licenced users can receive follow-up tasks. Some functionality, such as creating related improvement suggestions at the time of reporting, is not available when reporting via the API. 

Implementing the API

An integration engineer/web developer will use our API documentation to create and test the form you're providing to end users. 

Example of a form on your website that could be linked to Logiqc via the API:

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:

1. In Admin mode, select API keys from the left nav bar (Your account will need permission to Edit API keys).
2. Complete the Name, Expiry and IP filter fields and select Apply rate limit.  

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.