Components

How to use Component Documentation

Logging in with the Live Documentation

The live documentation links connect directly to our Swagger docs on our CI server. To use the API you’ll first need to get an access token from the Auth service, and then you’ll need to give that token when using one of the RESTful operations.

Obtaining an access token:

  1. goto the Auth service’s POST /api/oauth/token
  2. click on Authorize in the top right of the page
  3. in the box that has popped-up, enter username user-client and password changeme
  4. click Authorize under password
  5. enter the username administrator and password password
  6. click Try it out!
  7. In the Response body box, copy the UUID. e.g. "access_token": "a93bcab7-aaf5-43fe-9301-76c526698898" copy a93bcab7-aaf5-43fe-9301-76c526698898 to use later.
  8. Paste the UUID you just copied into any endpoint’s access_token field.

Auth

Security credentials, Authentication and Authorization. Uses OAuth2.

Fulfillment Service

Placing orders at warehouses, fulfilling those orders (ERP or Pick Pack Ship) and proof of deliveries.

CCE Service

Cold Chain Equipment: Catalog (PQS oriented), Inventory (equipment at locations) and functional status.

Report Service

Printed / banded reports. Owns report storage, generation, and seeding rights that users may be given.

Notification Service

Notifying users when their attention is needed.

Reference Data Service

Reference (meta) data for: users, facilities, programs, products, schedules, etc.

Reference UI

The Reference UI for web-based access through a web-browser. Compiles together all the assets that make up the OpenLMIS-UI. See the build process documentation to understand exactly how the UI is compiled.

Requisition Service

Requisitions (pull-based), Requisition Templates for requesting more stock on a schedule through an administrative hierarchy.