API

Webhooks

Um benachrichtigt zu werden, wenn ein Benutzer eine bestimmte Aktion ausführt, sind Webhooks nützlich, anstatt Daten abzufragen. Wir ermöglichen Ihnen die Angabe einer URL, die immer dann aufgerufen wird, wenn ein bestimmtes Ereignis eintritt, damit Sie diese Informationen in Ihrer Anwendung verwenden können.

Registrieren Sie zunächst einen Webhook in unserem Dashboard: https://dash.mave.io/settings

Erstellen Sie einen Endpunkt

Erstellen Sie zunächst einen Endpunkt in Ihrer Anwendung. In unserem Dashboard können Sie festlegen, welche Ereignisse bei jedem Aufruf dieser URL verwendet werden sollen. Diese Veranstaltungen sind verfügbar:

Veranstaltung Beschreibung
video.created Tritt auf, wenn ein Benutzer eine Videoeinbettung erstellt oder über die API erstellt wird.
video.uploaded Tritt auf, wenn ein Benutzer ein Video hochgeladen hat
video.processing Tritt auf, wenn ein Benutzer ein Video hochgeladen hat und wir mit der Verarbeitung des Videos begonnen haben. Es ist spielbereit, aber nicht für jeden Browser/jede Verbindung optimiert. Dadurch werden die Videometadaten als duration-, width-, height-, name-, poster_image- und last_upload-Feld aktualisiert.
video.ready Tritt für jede Wiedergabe auf, die die Codierung abgeschlossen hat
video.deleted Tritt auf, wenn ein Benutzer eine Videoeinbettung löscht oder über die API gelöscht wird.

Das Ereignisobjekt, das an Ihre Anwendung gesendet wird, sieht ähnlich aus wie unten beschrieben. Damit können Sie Ihre Bewerbung aktualisieren.

Nutzlast

{
  "id": "j3bw2jWb6q7aWGwChsgR86", // the id of this event
  "object": "event", // type of the object send to you
  "data": {
    "created": 1643723737, // when this video embed was created
    "duration": null, // duration of the video
    "width": null, // width of the video in pixels
    "height": null, // height of the video in pixels
    "id": "k1iFD7h4rW", // the ID if you want to store it for your user and possibly webhooks
    "last_upload": null, // when a video has been uploaded
    "name": null, // name of the file or chosen name
    "object": "video", // the type of object you're looking at
    "poster_image": null, // uploaded poster or first frame of video when uploaded
    "size": null, // size of the video
    "renditions": ["sd", "hd"] // size of the video
  }, // the data that triggered the event
  "type": "video.created", // the type of event that occured
  "created": 1643723823 // when the event was created
}

Sicherheit

Wenn Sie ein bestimmtes Framework verwenden, das bei Anfragen ein CSRF-Token enthält, sollten Sie dies für den von Ihnen definierten Webhook-Endpunkt deaktivieren. Anstatt seine Integrität zu überprüfen, verwenden wir ein Geheimnis, das immer dann gefunden werden kann, wenn Sie in unserem Dashboard einen Webhook erstellen. Stellen Sie sicher, dass Sie es sicher in Ihrer Anwendung aufbewahren.

Jedes Ereignis, das ausgelöst und an Ihren Server gesendet wird, enthält einen HTTP-Header Mave-Signature: t={signature_time}, v1={signature}. Diese Signatur kann zur Überprüfung verwendet werden und gibt das Geheimnis nicht preis. Um zu überprüfen, ob diese Signatur korrekt ist, können Sie mithilfe einer HMAC SHA256-Bibliothek selbst eine erstellen, um eine signierte Nutzlast zu generieren. Dazu verwenden Sie den Schlüssel: {signature_time}.{webhook secret} als Schlüssel und verschlüsseln den Payload-Body (aus der eigentlichen Anfrage). Das Ergebnis sollte genau das gleiche sein wie {signature}

🍪 Klicken Sie auf „Akzeptieren“, um zu bestätigen, dass Sie damit einverstanden sind, dass wir keine Cookies verwenden. Ja, dieses Banner ist nur zur Ansicht da!
Akzeptieren