Kontext dieses Dokuments: Die Flip Post API für Beiträge, Kommentare und Anhänge

Hier findest du eine Spezifikation zum Umgang mit Anhängen unter dem folgenden Link.

Flip API Dokumentation - Post

Um Dateien an einen Beitrag anzuhängen, müssen sie zuerst über den Attachment-Endpunkt hochgeladen werden. Nach einem erfolgreichen Upload erhältst du eine Anhangs-ID, die du weiter verwenden kannst.

Bitte beachte:

• Die Dateigröße ist auf 1 GB pro Datei begrenzt.
• Content-Transfer-Encoding: base64wird nicht unterstützt.
• Alle Flip APIs erlauben das Anhängen einer Datei mit der attachment_id erst, wenn die Hintergrundverarbeitung mit dem Status FINISHED abgeschlossen ist. Das bedeutet, dass das Überprüfen des Status nach dem Upload und vor der weiteren Verwendung zwingend erforderlich ist.

Dateien hochladen

Um eine Datei hochzuladen, sende eine multipart/form-data POST-Anfrage an /api/external/v1/attachments.

Hier ist ein Beispiel mit curl:

Anfrage:

curl -H "authorization: Bearer $TOKEN" -F file=@$PATH_TO_FILE <https://$DOMAIN/api/external/v1/attachments>

Ersetze $PATH_TO_FILE durch den Speicherort der Datei, die du hochladen möchtest. Vergiss nicht, einen Content-Type Header mit dem Dateityp hinzuzufügen, wenn du multipart/form-data manuell erstellst (siehe https://de.wikipedia.org/wiki/MIME#Multipart-Nachrichten). Dies bestimmt, wie der Anhang in der Anwendung angezeigt wird.

Bei Erfolg erhältst du einen 202 HTTP-Statuscode. Der 202-Statuscode zeigt an, dass die Datei noch im Hintergrund verarbeitet wird. Diese Hintergrundverarbeitung ist notwendig, um den Nutzern der Flip-App die bestmögliche Erfahrung zu bieten.

Antwort:

{
	"attachment_id": "4c76e620-6daa-46e6-9da1-9ac96abab601"
}

Nun kann die attachment_id für zwei Dinge verwendet werden:

1. Den Status der Hintergrundverarbeitung überprüfen.
2. Die Datei mit einer anderen API, wie der Post-API, an Inhalte anhängen.

Den Status der Hintergrundverarbeitung überprüfen

Um den Status deiner Datei in Bearbeitung zu erhalten, sende eine GET-Anfrage an /api/external/v1/attachments/$ATTACHMENT_ID/status

Hier ist ein Beispiel mit curl:

Anfrage:

curl -H "authorization: Bearer $AUTH" \\
	<https://$DOMAIN/api/external/v1/attachments/$ATTACHMENT_ID/status>

Ersetze $ATTACHMENT_ID mit der attachment_id, die du im vorherigen Schritt erhalten hast.

Antwort:

{
	"attachment_id": "4c76e620-6daa-46e6-9da1-9ac96abab601",
	"type": "VIDEO",
	"status": "IN_PROGRESS"
}

Die Felder erklärt:

• attachment_id: Die ID der Datei, für die du den Status abgefragt hast.
• type: Der Dateityp, den wir erkannt haben, entwederVIDEO, IMAGE oder MISC. MISCumfasst alle Arten von Dateien wie Textdokumente, PDFs, Archive…
• status: Der Status der Hintergrundverarbeitung. Mögliche Werte sind:
  • IN_PROGRESS: Der Anhang wird noch verarbeitet.
  • FINISHED: Die Verarbeitung wurde erfolgreich abgeschlossen und der Anhang kann jetzt anderweitig verwendet werden.
  • FAILED_BAD_FILE: Die hochgeladene Datei ist beschädigt und kann nicht verarbeitet werden.
  • FAILED_INTERNAL_ERROR: Es gab einen internen Fehler bei der Verarbeitung des Anhangs. Versuche es erneut und wenn das Problem weiterhin besteht, informiere deine Flip-Kontaktperson.

Wenn der Status FINISHED ist, kann die attachment_id in anderen Flip APIs verwendet werden.