Skip to main content

OpenLMIS Adaptor

About OpenLMIS​

OpenLMIS (Open Logistics Management Information System) is an open-source, electronic logistics management information system designed to improve the management and distribution of health commodities. It enables supply chain management, providing visibility and accuracy in inventory tracking, order management, and reporting.

Integration Options​

OpenLMIS v3 uses a micro-services architecture with different services each providing different APIs - see docs.

Rest API: OpenLMIS has a REST API that enables external services like OpenFn to pull data from OpenLMIS, or push data from external apps to OpenLMIS. This option is suited for scheduled, bulk syncs or workflows that must update data in OpenLMIS with external information. See functions for more on how to use this adaptor to work with the API.

Authentication​

  1. See OpenLMIS docs for the latest on supported authentication methods.
  2. The Auth Service in OpenLMIS v3 is a stand-alone micro-service that implements OAuth 2. See this adaptor's Configuration docs for more on the required authentication parameters.

When configuring your credential, clientId and clientSecret are required inputs for the authentication. If working with a demo environment, OpenLMIS provides default values for these inputs, which should be changed for any production system. In the below example, we have included these default values available.

See platform docs on managing credentials for how to configure a credential in OpenFn. If working locally or if using a Raw JSON credential type, then your configuration will look something like this:

{
  "password": "@some(!)Str0ngp4ss0w0rd",
  "username": "administrator",
  "baseUrl": "https://test.openlmis.org",
  "clientId": "user-client", // Default value for demo systems
  "clientSecret": "changeme" // Default value for demo systems
}
  1. OpenLMIS Documentation
  2. OpenLMIS API Guide
  3. Integration Guide

Implementation Examples​

Coming soon!