API-referentie
Base URL:
Viewer-URL's
Voor integratie in ng-front. De client bouwt alleen de URL; de service haalt de bron-HTML op bij Talentpool,
rendert PDF of DOCX en toont of downloadt het resultaat. Geen API-key nodig.
instance en uid accepteren [A-Za-z0-9._-].
| Parameter | Verplicht | Beschrijving |
|---|---|---|
| output | ja | pdf-view (PDF) of docx-view (Word). |
| instance | ja | Tenant/template, bijv. ict-nl. |
| uid | ja | CV-uid van het document. |
| environment | acc | acc → tp.acc.eazycv.com. Anders tp.eazycv.com. |
| filename | nee | Downloadnaam. Extensie wordt aangevuld. Fallback: {instance}-{uid}.{ext}. |
| debug | nee | 1 toont frames, timing en debugrapport. |
| beta | nee | true voegt ?beta=true toe aan de bron-URL. |
| plainmode | nee | true voegt ?plainmode=true toe aan de bron-URL. |
Outputtypes
| Route | Bron | Gedrag |
|---|---|---|
| /pdf-view/{instance}/{uid} | {tp}/pdf/{instance}/{uid} |
PDF.js-viewer (zoom, print, download). Te gebruiken als iframe src of nieuw tabblad. |
| /docx-view/{instance}/{uid} | {tp}/pdf/{instance}/{uid}?word=true |
Genereert .docx, start download, biedt Open in Word. Via window.open, niet in een iframe. |
Voorbeelden
| Variant | URL |
|---|---|
| PDF · prod | https://documents.eazycv.com/pdf-view/{instance}/{uid}?filename=Jan-Jansen.pdf |
| PDF · acc | https://documents.eazycv.com/pdf-view/{instance}/{uid}?environment=acc&filename=Jan-Jansen.pdf |
| Word · prod | https://documents.eazycv.com/docx-view/{instance}/{uid}?filename=Jan-Jansen.docx |
| Word · acc | https://documents.eazycv.com/docx-view/{instance}/{uid}?environment=acc&filename=Jan-Jansen.docx |
| Query-variant | /pdf-view?instance={instance}&uid={uid}&environment=acc |
Encodeer path- en query-waarden met encodeURIComponent. De bron-HTML
(https://tp.eazycv.com/pdf/{instance}/{uid}) is input voor deze service en geen eindgebruikers-URL.
Endpoints
| Route | Auth | Beschrijving |
|---|---|---|
| GET /health | — | Liveness. Retourneert status, timestamp en adobeConfigured. |
| POST /generate-pdf | X-API-Key | HTML-URL naar PDF. JSON, max 15 MB. |
| POST /generate-docx | X-API-Key | PDF of HTML-URL naar DOCX via Adobe. 503 zonder Adobe-credentials. |
| GET /pdf-view/{instance}/{uid} | — | PDF-viewer. Zie Viewer-URL's. |
| GET /docx-view/{instance}/{uid} | — | Word-download. Zie Viewer-URL's. |
Authenticatie
API-routes vereisen de header X-API-Key met de waarde van PDF_API_KEY.
Is PDF_API_KEY leeg, dan zijn de routes open. Een ongeldige sleutel geeft 401.
/benchmark gebruikt Basic Auth: gebruiker BENCHMARK_USER
(default benchmark), wachtwoord BENCHMARK_PASSWORD met fallback op PDF_API_KEY.
POST /generate-pdf Content-Type: application/json X-API-Key: <PDF_API_KEY>
Request body
Voor /generate-pdf is alleen url verplicht. Puppeteer-opties kunnen plat
(width, marginTop) of genest onder data.pdf_settings worden meegegeven.
Layout-CSS/JS hoort onder data.layout. Zonder formaat wordt A4 gebruikt.
Met preferCSSPageSize heeft CSS @page voorrang op width/height.
| Veld | Type | Default | Beschrijving |
|---|---|---|---|
| url | string | — | Bronpagina. |
| format | string | A4 | Papierformaat als width/height ontbreken. |
| width / height | string | 210mm / 297mm | Exacte paginamaat. |
| landscape | bool | false | Liggende oriëntatie. |
| printBackground | bool | true | Achtergrondkleuren en -afbeeldingen renderen. |
| omitBackground | bool | false | Witte pagina-achtergrond weglaten. |
| preferCSSPageSize | bool | false | @page bepaalt de maat, tenzij width+height gezet zijn. |
| scale | number | 1 | Renderschaal. |
| marginTop…Left | string | 0mm | Marges met eenheid (mm, cm, px). |
| displayHeaderFooter | bool | false | Chromium header/footer-templates tonen. |
| headerTemplate / footerTemplate | string | "" | HTML voor kop- en voettekst. |
pdf_settings & layout
data.pdf_settings en data.layout worden ook op topniveau geaccepteerd.
De response bevat in data.applied wat daadwerkelijk is toegepast: bron-URL, PDF-opties,
geïnjecteerde CSS/JS, Paged.js-status en waarschuwingen.
| Veld | Verwerking |
|---|---|
| pdf_settings.page.width/height | Paginamaat. Getallen zonder eenheid worden mm. |
| pdf_settings.margins.* | Puppeteer-marges; staan los van CSS @page-marges. |
| other.landscape / scale / printBackground / omitBackground | Direct naar page.pdf(). true, 1 en "yes" gelden als aan. |
| other.preferCSSPageSize | Bij true wint CSS @page; width/height blijven fallback. |
| other.displayHeaderFooter + templates | Chromium kop/voet. Lege templates blijven leeg. |
| layout.version / use_version2 | Selecteert *_beta CSS/JS. Lege beta valt terug op stable. |
| css_html, css_pdf (+ _beta) | Na navigatie geïnjecteerd, in die volgorde. <style>-wrappers worden verwijderd. |
| css_word (+ _beta) | Alleen bij HTML→DOCX; genegeerd bij PDF-output. |
| custom_javascript (+ _beta) | Uitgevoerd na CSS-injectie, vóór Paged.js. |
| use_pagedjs | true: wacht op previewDone (max 30 s). false: overslaan. Headers/footers via Paged.js CSS; zet displayHeaderFooter dan op false. |
| layout.settings | Paginaformaat en marges → @page. Kleuren, typografie en structuur → CSS-variabelen --layout-*. |
| custom_template_name | Alleen gelogd; het template zit in de bron-URL. |
DOCX
POST /generate-docx ondersteunt twee bronnen. Default is een bestaande PDF.
Met source: "html" rendert Chromium eerst een PDF, die vervolgens door Adobe naar DOCX wordt geëxporteerd.
| Veld | Type | Default | Beschrijving |
|---|---|---|---|
| source | string | pdf of html. | |
| url | string | — | PDF-URL (source=pdf) of HTML-URL (source=html). |
| pdfBase64 | string | — | PDF als base64; alternatief voor url bij source=pdf. |
| ocrLang | string | nl-NL | OCR-taal voor de Adobe-export. |
Bij source=html gelden alle velden van /generate-pdf.
Configuratie: ADOBE_CLIENT_ID, ADOBE_CLIENT_SECRET, optioneel
ADOBE_API_URL (default https://pdf-services.adobe.io).
Response
{
"status": "success",
"data": {
"base64file": "JVBERi0xLjc...",
"duration": 1.42,
"requestId": "a1b2c3d4e5f6",
"applied": { /* toegepaste pdf- en layoutinstellingen */ },
"timings": { /* navigateMs, fontsMs, pagedjsMs, pdfMs, pages, localAssets */ }
}
}
| Veld | Beschrijving |
|---|---|
| base64file | PDF- of DOCX-bestand, base64-gecodeerd. |
| duration | Totale verwerkingstijd in seconden. |
| requestId | Correlatie-ID voor logs en error-screenshots. |
| applied | Per veld: geïnjecteerd, overgeslagen of fallback. |
| timings | Duur per fase: navigatie, fonts, Paged.js, page.pdf(). |
Statuscodes en timeouts
| Code | Betekenis |
|---|---|
| 400 | Geen bron opgegeven. |
| 401 | Ontbrekende of ongeldige X-API-Key. |
| 500 | Navigatie-, render- of exportfout. Bevat error en requestId. |
| 503 | Adobe PDF Services niet geconfigureerd. |
Timeouts: navigatie 45 s, PDF-generatie 30 s, Adobe-polling max 90 s.
Voorbeelden
Postman-collectie (v2.1) met variabelen baseUrl en apiKey:
download .json.
curl -sS /generate-pdf \
-H 'Content-Type: application/json' \
-H "X-API-Key: $PDF_API_KEY" \
-d '{
"url": "https://example.com/document",
"width": "210mm",
"height": "297mm",
"printBackground": true
}'
curl -sS /generate-docx \
-H 'Content-Type: application/json' \
-H "X-API-Key: $PDF_API_KEY" \
-d '{
"source": "html",
"url": "https://example.com/document",
"width": "210mm",
"height": "297mm",
"ocrLang": "nl-NL"
}'