PAL Gate icon

PAL Gate

Consume PAL Portal API

Auth → Test Connection

AI-generated

Summary

Test the PAL Gate API connection by sending a minimal request (places tree) and verifying authentication.

Inputs

  • requestOptions — Options for the request, including batching (batchSize and batchInterval) to control request throttling.
  • allowUnauthorizedCerts — Accept responses with invalid SSL certificates; default is false.
  • proxy — HTTP proxy URL, optionally with embedded credentials, e.g., http://user:pass@host:port.
  • timeout — Request timeout in milliseconds (minimum 1); default is 10000 ms.

Output shape

object

On success the operation returns the parsed JSON response from the PAL Gate test endpoint (typically the place tree data). On failure an error is thrown; no response body is returned on error.

Examples

Example 1: Basic connection test using default settings

allowUnauthorizedCerts=false, proxy='', timeout=10000, requestOptions={"batching":{"batchSize":50,"batchInterval":1000}}

Example 2: Ignore SSL errors to connect to self‑signed cert

allowUnauthorizedCerts=true, proxy='', timeout=15000, requestOptions={"batching":{"batchSize":100,"batchInterval":0}}

Example 3: Use HTTP proxy for outbound requests

allowUnauthorizedCerts=false, proxy='http://username:password@proxy.example.com:8080', timeout=20000, requestOptions={"batching":{"batchSize":10,"batchInterval":500}}

Links

Discussion