API Proxies
Link offers API proxy functionality that utilizes an OAS file with enosix-specific extensions, providing a user-friendly interface to SAP data.
Configuration
To configure API Proxies, a new API Proxies section must be defined in the configuration. Each API Proxies section binds a Server (SAP server), API Source (OAS file) and a URL path.
API Proxies Properties
Each API Proxies object contains the following properties:
| Property | Required | Description |
|---|---|---|
| Path | Yes | Sets the base path for the endpoints defined in the OAS file |
| Server | Yes | The name of the Server that the API Proxy is associated with |
| APISource | Yes | The name of the APISource that the API Proxy is associated with |
| SanityCheckEnabled | No | Enables the Sanity Check endpoint /{path}/sanity-check. Default: True |
| MetaDataDownloadEnabled | No | Enables the /{path}/metadata endpoint. This endpoint will return the SAP Metadata for a provided CSV BOM. Default: True |
| LoggingWebhookEnabled | No | Whether or not the API Proxy should log to a webhook when provided the SERVER_LOG_WEBHOOK_URL header. See Request Webhook Default: False |
| Cookie | No | Adds a Static Cookie to each SAP request. See Cookie Injection |
Example
ApiProxies__0__Path: dev/salesdoc
ApiProxies__0__Cookie: WebBalancerToken=UniqueValue
ApiProxies__0__Server: sap-ecc-dev
ApiProxies__0__APISource: enosix-salesdoc
ApiProxies__0__SanityCheckEnabled: true
ApiProxies__0__MetaDataDownloadEnabled: true
ApiProxies__0__SwaggerEnabled: true
ApiProxies__0__LoggingWebhookEnabled: true