Overview
A good place to start is with the API Gateway Technical Information Paper.
Command Centre Cloud API Gateway - Technical Information Paper
Using the gateway
As per the technical information paper, the gateway is designed to transparently allow REST API requests without modification.
When making requests, you do not need to alter the payload, HTTP headers or client certificates that you use; these should all be the same as if you were connecting directly to the server’s REST API via a local network connection.
After enabling the Gateway for your server and REST API user, you need only to replace the local server's URL with the cloud API Gateway one.Example Local request:
<client certificate thumbprint e89ef121958c675c736efd3fdcd87ca31d502fde> GET https://servername.yourcompany.local:8904/api/cardholders Authorization: GGL-API-KEY F6F0-C8F0-60AF-7501-AFB9-C523-B2D3-1D3E
Equivalent Gateway request:
<client certificate thumbprint e89ef121958c675c736efd3fdcd87ca31d502fde> GET https://commandcentre-api-au.security.gallagher.cloud/api/cardholders Authorization: GGL-API-KEY F6F0-C8F0-60AF-7501-AFB9-C523-B2D3-1D3E
Region Details
Australian Gateway Region:
DNS address: commandcentre-api-au.security.gallagher.cloud
IP Addresses: 3.106.1.6 and 3.106.100.112
United States Gateway Region:
DNS address: commandcentre-api-us.security.gallagher.cloud
IP Addresses: 44.193.42.111 and 3.209.194.103