S3 API
Für S3-Connectoren stellt die API Endpunkte zum Lesen und Schreiben von Dateien bereit.
Index
Gib einen Ordner-path
an, um die darin enthaltenen Dateien aufzulisten.
http request GET https://core.orbitype.com/api/s3/v1?path=blog/posts/
Antwort:
[
"blog/posts/alpha.json",
"blog/posts/bravo.json",
"blog/posts/charlie.json"
]
Anzeigen
Gib einen Datei-path
an, um deren Inhalt abzurufen.
http request GET https://core.orbitype.com/api/s3/v1?path=blog/posts/alpha.json
Antwort:
{
"title": "Alpha",
"text": "Lorem ipsum dolor."
}
Speichern
Erstelle oder überschreibe eine Textdatei, indem du einen path
und einen body
übergibst.
Anfrage:
http request PUT https://core.orbitype.com/api/s3/v1
Antwort:
{
"path": "blog/posts/neo.json",
"body": { "title": "Neo", "text": "Ein weiterer Beitrag" }
}
Löschen
Lösche eine Datei, indem du einen path
übergibst.
http request DELETE https://core.orbitype.com/api/s3/v1
{
"path": "blog/posts/alpha.json"
}
Kopieren
Kopiere eine Datei, indem du die Pfade für from
und to
angibst.
http request POST https://core.orbitype.com/api/s3/v1/copy
{
"from": "blog/posts/alpha.json",
"to": "blog/posts/alpha-copy.json"
}
Hochladen
Um eine nicht-textbasierte Mediendatei zu erstellen, sende eine multipart/form-data-Anfrage.
Übergebe den path
als Query-Parameter und die file
als Teil der Anfrage.
http request POST https://core.orbitype.com/api/s3/v1/upload
?path=blog/media/cover.jpg
Content-Type: multipart/form-data
Content-Disposition: form-data; name="file"; filename="cover.jpg"
Content-Type: image/jpeg