Page Comparison

OMS uses API's APIs to pull data from the IHQ database and load the information into the application. The OMS API's APIs can be run in Postman to access the desired JSON data. There are many options in Postman so the following outlines what a user needs to do in order to get results when calling an OMS API. 

Overview

URL

Users should refer to the

articles below for each OMS API as the parameters will vary for each

one. It is important to format the URL correctly to ensure the request can be returned. The following articles will offer additional information regarding each API URL and the available parameters. All of these APIs are "GET" calls and return JSON data. All endpoints require an authorization header included in the request.

Base URL: https://ips-api-prod.salvationarmy.org/

Authorization

Postman calls will need to be checked via the LDAP permissions before any data is returned. So a valid user must be used before making the call. The password will be the Lotus Notes Internet password for the user.

• Select the "Authorization" tab
• Set the type to "Basic Auth"
• Enter your email and password

Image Removed

Authorization

In order to call IPS APIs, an `access_token` is required to be sent in the `authorization` header with the request. In order to retrieve a token, a client application registration is required. To set up machine-to-machine access, follow the steps outlined in the document below.

Related articles