Getting Started

This guide walks you through setting up your environment and making your first API call.

Prerequisites

• A valid NMS user account with assigned facility access
• A tool for making HTTP requests (e.g., curl, Postman, or any HTTP client)

Step 1: Authenticate

All API requests (except health checks) require a valid JWT token. Obtain one by calling the login endpoint:

$
curl -X POST https://testapi.nms.go.ug/api/v1/auth/login \
>
  -H "Content-Type: application/json" \
>
  -d '{
>
    "username": "your_username",
>
    "password": "your_password"
>
  }'

Response:

1
{
2
  "token": "eyJhbGciOiJIUzM4NCJ9...",
3
  "expiresIn": 3600
4
}

Save the token value — you’ll include it in all subsequent requests.

Step 2: Make an Authenticated Request

Include the token in the Authorization header to call any protected endpoint. For example, to search for a facility:

$
curl -X GET "https://testapi.nms.go.ug/api/v1/master/facilities?keyword=bubulo" \
>
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

Step 3: Explore the API

Here are useful starting points depending on your use case:

Collection Variables

These variables are used throughout the API and should be set based on your context: