Zum Hauptinhalt springen

Ergebnis-PDF serverseitig abrufen

Frage​

Wir übermitteln die Konfiguration per Webhook an unser CRM. Das übertragene JSON enthält im Feld pdf einen API-Endpunkt zum Abruf des Ergebnis-PDFs. Der Endpunkt scheint aber nur aus der Anwendung heraus aufrufbar zu sein. Wie können wir das PDF serverseitig abrufen und im CRM zum Datensatz ablegen?

Antwort​

Der Endpunkt hinter dem Feld pdf ist nicht öffentlich. Ein Aufruf ohne Authentifizierung schlägt fehl – aus dem Konfigurator heraus funktioniert er nur, weil dort die Sitzung des Nutzers mitläuft. Für einen serverseitigen Abruf brauchen Sie ein permanentes API-Token.

API-Token erzeugen​

  1. Klicken Sie oben links auf das K3-Logo, um in die Verwaltungsoberfläche zu wechseln.
  2. Klappen Sie rechts oben das Menü hinter Ihrer E-Mail-Adresse auf und wählen Sie Profil.
  3. Aktivieren Sie den Schalter Entwickler-Modus.
  4. Erzeugen Sie mit Neu ein neues API-Token.

Dieses Token übergeben Sie bei jedem Aufruf des PDF-Endpunkts zur Authentifizierung. Die Aufrufdetails finden Sie in der API-Dokumentation.

Variante: öffentlicher Endpunkt ohne Kundendaten​

Wenn das abgerufene PDF keine Kundendaten enthalten muss, gibt es einen zweiten Weg ohne Token. Der Endpunkt

/cfg/{cfg}/pdf/{template?}

enthält die Daten aus dem Kontaktformular und ist deshalb nur autorisiert abrufbar. Daneben gibt es

/cfg/{cfg}/publicPdf/{template?}

Dieser Endpunkt lässt sich ohne Authentifizierung aufrufen, etwa direkt aus dem Webhook heraus. Das darüber erzeugte PDF enthält ausschließlich die Konfiguration, keine Kundendaten. Sobald Sie die Kundendaten im PDF brauchen, führt der Weg wieder über die API mit Token und der entsprechenden Lizenz.

Alternative ohne eigenen Abruf​

Sie können das PDF auch an die interne E-Mail-Adresse Ihres Konfigurators senden lassen und es von dort weiterverarbeiten. Das ist besonders dann praktisch, wenn der Endkunde das PDF nicht sofort erhalten soll – etwa weil er zuvor einen Double-Opt-in bestätigen muss. Der Versand an den Kunden erfolgt dann aus Ihrem System, nachdem die Bestätigung vorliegt.

Token nicht im Frontend verwenden

Ein permanentes API-Token gehört ausschließlich in serverseitigen Code. Binden Sie es nicht in Webseiten oder JavaScript ein, das der Endkunde laden kann.

Weiterführende Informationen​

Verwandte Themen​

  • Downloadlink zum PDF
  • Konfiguration ans CRM übergeben
  • API-Authentifizierung