API Reference

The NMS API Platform Reference provides detailed technical documentation for all available endpoints. Our API is organized by functional modules to help you quickly find the resources you need.

How to use the Reference

Each endpoint in the reference includes:

Endpoint URL: The full path to the resources.
Method: The HTTP method (GET, POST, etc.).
Parameters: Detailed descriptions of path, query, and body parameters.
Request Examples: Sample requests in multiple languages (Curl, Python, Go, etc.).
Response Schema: Interactive JSON examples showing exactly what the API returns.

Interactive Explorer

You can test the API directly from your browser using the “Try It” button on any endpoint page.

Remember to set your Authorization header with a valid JWT token before making requests. You can generate a token using the Login endpoint.

API Modules

The following modules are available in this reference:

Authentication: User session management and login.
Orders: Program, EMHS, Special, and Supplementary orders.
Procurement Plans: Facility-specific procurement strategies.
Deliveries: Tracking shipments from NMS to facilities.
Patient Statistics: Data submission for HIV, ARV, and other health programs.
Master Data: Lookups for facilities, products, and cycles.

Select a module from the sidebar to begin exploring.