REST API: Erste Schritte

Erstelle einen API-Token, sende deine erste Anfrage und finde die vollständige API-Referenz für fynk.

Zuletzt aktualisiert Vor 7 Tagen

Mit der fynk REST API verbindest du fynk mit deinen eigenen Systemen: Dokumente aus Vorlagen oder PDFs erstellen, dynamische Felder und Metadaten befüllen, Unterzeichner hinzufügen, die Unterzeichnung starten und das unterschriebene PDF herunterladen.

Verfügbar in Business und Pro · Eigentümer

Bevor du startest

Lege unter Kontoeinstellungen → Meine Parteien mindestens eine Partei an.
Lege mindestens eine Vorlage an, wenn du Dokumente aus Vorlagen erstellen willst.

API-Token erstellen

Gehe zu Kontoeinstellungen → API-Integrationen und klicke auf der Kachel fynk API auf Konfigurieren.
Klicke unter API-Tokens auf Token erstellen.
Gib unter Neuen API-Token erstellen einen Token-Namen ein und wähle eine oder mehrere Rollen: Dokument-Leser, Dokument-Manager, Dokument-Löscher, Vorlagen-Leser, Vorlagen-Manager, Tag-Manager, Metadaten-Manager. Die Rollen bestimmen, was der Token darf.
Optional legst du ein Ablaufdatum fest. Der Token läuft an diesem Datum automatisch ab. Lass das Feld leer, wenn er nicht ablaufen soll.
Kopiere den Token und bewahre ihn sicher auf. Du siehst ihn nicht noch einmal.

Die Liste API-Tokens zeigt für jeden Token Name, Erstellungsdatum, Ablaufdatum und Rollen.

Erste Anfrage senden

Sende den Token im Header jeder Anfrage mit:

Authorization: Bearer <your token>Accept: application/json

Teste ihn mit GET https://app.fynk.com/v1/api/me. Du solltest eine 200-Antwort mit Details zu deinem Token bekommen.

Was du mit der API machen kannst

Dokumente aus einer Vorlage oder einem PDF erstellen
Dokumente auflisten, lesen und aktualisieren
Dynamische Felder und Metadaten befüllen
Parteien und Unterzeichner hinzufügen, ändern und entfernen
Dokumente in die Prüfung oder Unterzeichnung verschieben
Das aktuelle PDF herunterladen
Dateien anhängen und Dokumente verknüpfen

API-Referenz

Endpunkte, Parameter und Beispiele findest du in der API-Referenz in diesem Help Center. Sie wird aus dem API-Schema von fynk synchronisiert. Die Referenz ist auch unter app.fynk.com/v1/docs verfügbar.

Für die Werte des Signaturtyps, einschließlich aes_eid, siehe Dokument aktualisieren. AES (eID) nutzt sequenzielle Unterzeichnung. Den Ablauf findest du unter Signaturarten.

Signaturpositionen vor dem Automatisieren vorbereiten

Einen Unterzeichner hinzuzufügen und seinen Signaturblock zu platzieren, sind getrennte Schritte. Die veröffentlichte API bietet keinen eigenen Endpunkt, um Signaturblöcke auf einem hochgeladenen PDF zu positionieren. Für einen wiederholbaren Ablauf erstellst du Dokumente aus einer Vorlage, in der die Blöcke schon platziert sind. Bei einmaligen PDFs platzierst du die Blöcke in fynk, bevor du das Dokument in die Unterzeichnung verschiebst.

API-Version

Wähle auf der Seite fynk API unter API-Versionseinstellungen die Standard-API-Version, zum Beispiel 2025-06-06. fynk nutzt diese Version für jede API-Anfrage, die keinen fynk-Api-Version-Header sendet. Eine Änderung des Standards kann bestehende Integrationen betreffen, die den Header nicht senden.

Das API-Versions-Changelog listet die Änderungen pro Version. Der Button API-Dokumentation öffnet die API-Referenz.

Gut zu wissen

Tokens, die du während der Testphase erstellst, funktionieren nach der Testphase nicht mehr, außer du wechselst auf einen bezahlten Tarif.
Jeder Token bekommt Rollen (z. B. Document Reader, Document Manager, Template Reader), die bestimmen, was er darf, und ein optionales Ablaufdatum. Tokens lassen sich nicht auf bestimmte Teams beschränken.
Die API hat ein Limit pro Minute. Wenn du es überschreitest, bekommst du eine 429-Antwort mit einem Retry-After-Header.
Lege pro Anfrage mit dem Header fynk-Api-Version eine API-Version fest. Ohne den Header wird die Standard-API-Version verwendet. Inkompatible Änderungen kommen immer mit einer neuen Version.
Parteien und Unterzeichner lassen sich nur ändern, solange ein Dokument im Entwurf oder in der Prüfung ist.
Unterzeichner können nach dem Unterschreiben nicht auf deine Website weitergeleitet werden. Sie kehren zu dem Tab zurück, in dem sie das Dokument geöffnet haben.
Um auf Ereignisse in fynk zu reagieren, statt regelmäßig abzufragen, nutze Webhooks. Siehe Webhooks.