Download OpenAPI specification:Download
Firefly Service's RESTful InDesign APIs offer resources to automate tedious, time-consuming design tasks through scalable cloud services, encouraging more personalization at scale, creative automation, and faster content delivery.
The Data Merge API is used to create document variations from CSV data and an InDesign file.
The Data Merge API supports UTF-16BE encoding for CSV files, which is necessary for languages or characters requiring multi-byte representation. For plain English characters, the CSV will function correctly even without this encoding.
Returns InDesign documents or PDFs that are created by merging the data provided and the specified template.
The data merge output MIME types are:
image/jpeg for JPEG. image/png for PNG. application/pdf for PDF. application/x-indesign for INDD. | x-gw-ims-org-id | string This is the identifier for Adobe Identity Management Service (IMS) as defined in Adobe's developer console. This is optional. |
| x-api-key required | string The API key as defined in Adobe's developer console. |
| Authorization required | string The authorization token with bearer "token_value". |
This job request object specifies parameters for merging the data with the given template.
required | Array of objects (InputAsset) Information about the assets, which will be used to process the job. |
required | object |
Array of objects (OutputAsset) |
The job/capability has been accepted for processing.
Bad Parameter
Unauthorized
Forbidden
Not Found
Too Many Requests
Internal Server Error
{- "assets": [
- {
- "source": {
- "url": "string",
- "storageType": "Azure"
}, - "destination": "string"
}
], - "params": {
- "generalSettings": {
- "fonts": {
- "fontsDirectories": [
- "string"
]
}, - "links": {
- "replaceLinks": [
- {
- "targetDocument": "string",
- "mapping": [
- {
- "currentURI": null,
- "linkID": null,
- "newAssetRelativePath": null
}
]
}
]
}, - "appLogs": {
- "logsRelativePath": "string"
}
}, - "targetDocument": "string",
- "dataSource": "string",
- "outputMediaType": "image/jpeg",
- "exportSettings": {
- "jobOptionsFile": "string",
- "pdfPreset": "High Quality Print",
- "quality": "low",
- "linkImages": false
}, - "recordRange": "string",
- "allowMultipleRecordsPerPage": true,
- "multipleRecordLayoutOptions": {
- "arrangeBy": "rows_first",
- "bottomMargin": "string",
- "topMargin": "string",
- "leftMargin": "string",
- "rightMargin": "string",
- "columnSpacing": "string",
- "rowSpacing": "string"
}, - "imagePlacementOptions": {
- "centerImage": true,
- "fittingOption": "content_aware_fit",
- "linkImages": true
}, - "pagesPerDocument": 0,
- "removeBlankLines": false,
- "convertUrlToHyperlink": true,
- "outputFileBaseString": "string",
- "outputFolderPath": "string"
}, - "outputs": [
- {
- "destination": {
- "url": "string",
- "storageType": "Azure"
}, - "source": "string"
}
]
}{- "jobId": "string",
- "statusUrl": "string"
}Retrieves the data merge tags from a document.
| x-gw-ims-org-id | string This is the identifier for Adobe Identity Management Service (IMS) as defined in Adobe's developer console. This is optional. |
| x-api-key required | string The API key as defined in Adobe's developer console. |
| Authorization required | string The authorization token with bearer "token_value". |
This job request object specifies parameters for retrieving the data merge tags.
required | Array of objects (InputAsset) Information about the assets, which will be used to process the job. |
required | object |
The job/capability has been accepted for processing.
Bad Parameter
Unauthorized
Forbidden
Not Found
Too Many Requests
Internal Server Error
{- "assets": [
- {
- "source": {
- "url": "string",
- "storageType": "Azure"
}, - "destination": "string"
}
], - "params": {
- "generalSettings": {
- "fonts": {
- "fontsDirectories": [
- "string"
]
}, - "links": {
- "replaceLinks": [
- {
- "targetDocument": "string",
- "mapping": [
- {
- "currentURI": null,
- "linkID": null,
- "newAssetRelativePath": null
}
]
}
]
}, - "appLogs": {
- "logsRelativePath": "string"
}
}, - "targetDocument": "string",
- "dataSource": "string",
- "filter": "text, image",
- "includePageItemIdentifiers": false
}
}{- "jobId": "string",
- "statusUrl": "string"
}