POST /api/v3/api/export/visit_pdf
Authentication
- HTTP BasicAuth with guid and API key. See: https://tools.ietf.org/html/rfc7617
Required HTTP Headers
- X-Plugin-Version
- X-Plugin-Identifier
How it works
1) The requested PDF gets requested with its guid as parameter.
2) The response depends on wheter the PDF is already created or not. Thus there may come a “wait” Reponse with a suggested amount of seconds before Request (1) shall be redone as well as a download_token“.
3) When the PDF is generated the loop above ends with a direct delivery of the binary PDF file.
Supported Formats
json
Errors
Code Description 401 Wrong credentials given 403 Invalid or missing X-Plugin-Version / X-Plugin-Identifier header
Examples
POST /v3/api/export/visit_pdf
{
"visit_guid": "<crm_id>",
"download_token": "<GUID if already given>"
}
HTTP 202
{
"wait": 5,
"download_token": "<GUID>"
}
HTTP 201
<binary PDF file>
Params
| Param name | Description |
|---|---|
| visit_guid optional |
Visit GUID from previous API call
Validations:
|