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:
- goto the Auth service’s POST /api/oauth/token
- click on
Authorizein the top right of the page
- in the box that has popped-up, enter username
- enter the username
Try it out!
- In the
Response bodybox, copy the UUID. e.g.
a93bcab7-aaf5-43fe-9301-76c526698898to use later.
- Paste the UUID you just copied into any endpoint’s
Security credentials, Authentication and Authorization. Uses OAuth2.
Placing orders at warehouses, fulfilling those orders (ERP or Pick Pack Ship) and proof of deliveries.
Cold Chain Equipment: Catalog (PQS oriented), Inventory (equipment at locations) and functional status.
Printed / banded reports. Owns report storage, generation, and seeding rights that users may be given.
Notifying users when their attention is needed.
Reference Data Service¶
Reference (meta) data for: users, facilities, programs, products, schedules, etc.
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.
Requisitions (pull-based), Requisition Templates for requesting more stock on a schedule through an administrative hierarchy.