Arbeiten mit der API von MediaAPI – Net Inventors GmbH

Nachfolgend ein paar Beispiele, wie du mit der MediaAPI arbeitest. Um die API zu testen empfehlen wir die Programme Insomina oder Postman .

Stelle sicher, dass dein Shop erreichbar ist und du einen validen API Key eines Backend Benutzers verwendest.

Die vollständige API findest du hier.

Medien per API in den Shop übertragen

Um Medien in den Shop per API zu übertragen sind zwei Schritte notwendig, zunächst musst ein Eintrag angelegt und da nach, in einem zweiten Request, das Medium übertragen werden.

1. Eintrag anlegen

Mit dem Post Request: "/api/NetiMedia/" und dem im Json formatierten Inhalt:

{
  "title": "Test media",
  "active": true,
  "filename": "test.txt",
  "uri": "www.netinventors.de",
  "local_copy": true,
  "description": "This is my description of my media.",
  "copyright": "Copyright by Net Inventors GmbH",
  "start_time": "2019-01-01T08:00:00Z",
  "end_time": "2019-12-31T08:00:00Z",
  "comment": "This is my comment.",
  "reference_uid": "K008",
  "display_in_account": true
}

erstellst du einen Eintrag.

Hier: findest du weitere Infos zum Inhalts des Json Objekts:
https://app.swaggerhub.com/apis-docs/netinventors/Media/1.0.0#/media/post_api_NetiMedia_

Im besten Fall erhältst du als 201 Response "Created" mit der Rückgabe im Json Format:

{
 "success": true,
 "data": {
 "id": 40,
 "title": "Test media",
 "active": true,
 "filename": "test.txt",
 "uri": "files\/NetiMedia",
 "local_copy": true,
 "description": "This is my description of my media.",
 "copyright": "Copyright by Net Inventors GmbH",
 "start_time": null,
 "end_time": null,
 "comment": "This is my comment.",
 "reference_uid": "K008",
 "filesize": 0,
 "filehash": "",
 "crtime": "2020-06-11T16:11:48Z",
 "cruser": 51,
 "mime_type": {
 "id": null,
 "name": null
 },
 "display_in_account": true
 }
}

Wichtig ist hier die ID - im Beispiel die 40.

Datei übertragen

Nun kannst du per Post: /api/NetiMedia/{media_id}/file/ deine Datei per API senden.
Hier findest du weitere Informationen.

Ablauf im Insomnia:

Eintrag erstellen:

Verwende als Methode "Post" und das Format "Json"
Füge im Json Format die Stammdaten ein:
Gib die Authorisierung ein (API Benutzername und API Key)
Nach dem Absenden erhältst du als Ergebnis du einen Response(201) mit dem Inhalt "success:true"
Bitte beachte, es wurde lediglich ein Eintrag in den Datenbank angelegt aber noch keine Datei übertragen.
Ansicht im Backend:

Medium übertragen

Bis jetzt wurde nur der Datenbankeintrag erstellt, die eigentliche Datei muss noch übertragen werden. Dazu wird nun ein weiterer Request erstellt.

Wähle in Insomnia als Methode "Post" und als Inhalt "Binary File"
Wichtig ist hier: die Id des Datensatzes, den wir aktualisieren wollen.
http://sw56x.dev.localhost/api/NetiMedia/40/file
Weitere Informationen.
Authentifizierung nicht vergessen...
Nach dem Absenden, wird die Datei übertragen und succes auf "true" als Response übertragen.
Ansicht im Backend nach erfolgreicher Übertragung.