Export API Settings

Release 3.3.2602 and above.

Use the editor.export.api key to set the export API endpoint.

The URL can be freely configured according to the back-end environment.

You can connect and use the default Export API server (Docker image or Node server) directly, or you can configure it to go through a proxy server and use a separate API endpoint as needed.

For details about the Export API server configuration and execution method, refer to the Export API Server manual.

Configuration

KeyDescription
editor.export.apiSets the export API (URL). Document files are sent to this API (URL).
editor.export.paramSets the parameters to be sent together with the export request.
editor.export.headersSets the export request headers.
editor.export.requestOptionsSets the request options to use for the export request. See editor.export.requestOptions below.

editor.export.requestOptions

Sets the request options to use for the export request.

keytypeDescription
credentialsbooleanSpecifies whether to include authentication info (cookies, auth headers, etc.) when sending an AJAX request to another domain.
timeoutnumberSets the response wait time for the request in milliseconds (ms).

Configuration Example

// synapeditor.config.js
{
    'editor.export.api': '/exportFile',
    'editor.export.param': {},
    'editor.export.headers': {},
    'editor.export.requestOptions': {credentials: true, timeout: 300},
}