Version: 5.2.x

Read Client/s

To read existing client records you will need to make a TLS request to the OpenHIM API for the below method and endpoint.

Read all clients

Method: GET
Endpoint: {openhim_url}:8080/clients

Read a specific client

Method: GET
Endpoint: {openhim_url}:8080/clients/:clientId

Read a specific client by domain

Method: GET
Endpoint: {openhim_url}:8080/clients/domain/:clientDomain

:clientDomain is the domain property of the client to fetch.

Example

Before we can send our request to the OpenHIM API we need to ensure that we construct our valid HTTP headers to successfully authenticate with the OpenHIM API.

Copy the below code at the bottom of your nodejs script that handles the authentication of the OpenHIM headers as described in the authentication section.

Replace the openhimOptions values with the correct implementation details

// append below code to the "openhim-api.js" script containing the authentication methods.
// This is described within the authentication section
(async () => {
const openhimOptions = {
apiURL: 'https://localhost:8080',
apiEndpoint: '/clients/clientId',
username: 'root@openhim.org',
password: 'openhim-password',
rejectUnauthorized: false
}
const headers = await genAuthHeaders(openhimOptions)
const options = { method: 'GET',
url: `${openhimOptions.apiURL}${openhimOptions.apiEndpoint}`,
rejectUnauthorized: openhimOptions.rejectUnauthorized,
headers: headers
}
request(options, (error, response, body) => {
if (error) throw new Error(error)
console.log({
statusCode: response.statusCode,
body
})
})
})()

The response status code will be 200 if successful.