The Synapcus Automation API includes a proxy server designed to translate automation calls into Synapcus native calls seamlessly. This setup allows external systems to interact with Synapcus functionalities using standardized API requests. To authenticate these requests, each automation call must include an API Authorization Key, which can be provided in one of two ways:
As an HTTP Header Argument:
Preferably, include the API Authorization Key in the request header for enhanced security. This method minimizes potential exposure of the key in URLs, which could be logged or cached. Use the header format as follows:
headers: {
'x-api-key': '17f87955-4983aa8d-d4f668b4-361aa4ce-9ba57f11-25336473-e50d24fb-4e6eab99'
}
Alternatively, As a URL Parameter:
If necessary, the API Authorization Key can also be appended directly to the request URL as a query parameter. However, this method is less secure than using the HTTP header and should be used with caution:
...&apiKey=17f87955-4983aa8d-d4f668b4-361aa4ce-9ba57f11-25336473-e50d24fb-4e6eab99
We strongly recommend using the HTTP header method to include the API key, as it provides better security by reducing the key's exposure.
Proxy Endpoints:
The Synapcus Automation API facilitates access to all standard Synapcus endpoints (GET, PUT, POST, DELETE) through a proxy server. The available proxy endpoints are:
-
GET /proxyPiped -
PUT /proxyPiped -
POST /proxyPiped -
DELETE /proxyPiped
These endpoints act as intermediaries, ensuring that your automation calls are properly authenticated and formatted to interact with Synapcus's backend.
Example Usage:
To call the GET /xrContacts endpoint with a specific query (e.g., filtering by per_lastname), you would use the proxyGetPiped endpoint along with the required API Authorization Key and your query parameters. Here is a conceptual example:
GET /proxyPiped?url=/xrContacts.xsp&query=[per_lastname]=Mustermann
hostname=synforge-propertec.synapcus.com/synforge/api/syn
protocol=https
A comprehensive list of Synapcus API endpoints is available in the following sections: