API User's Guide

Integration with external applications

Alloy Navigator allows you to store and edit configurations for applications that use the API to communicate with Alloy Navigator. Via the API, configurations can be uploaded to mobile applications.

NOTE: You can access application configurations from the Settings App: Services > Mobile Applications. For details, see Settings App Help: Configuring mobile applications.

Getting application configuration

To upload a configuration to an application, use the following request.

HTTP method

GET

API URL
http://www.example.com/api/v2/GetAppConfig
URL parameters
Parameter Description

par_app_name

The application name (Application ID) as it is registered in the Alloy Navigator Settings App under Services > Mobile Applications.

Example

This is an example of how you can get the configuration of the Alloy Inventory Scanner application.

Request:

(GET) http://www.example.com/api/v2/GetAppConfig?par_app_name=InventoryScanner

Response in JSON format:

{
	"success": true,
	"errorCode": 0,
	"errorText": "",
	"responseObject": {
		"Actions": [{
		"ActionID": "{A4E0000E-FC8E-4FB6-BE3C-F387830FADA8}",
		"DisplayName": "Inventory","ResponseText": "Inventory completed"
		}]
	}
}