Support Kontakt Support | Systemstatus Systemstatus
Seiteninhalt

    Überblick: Delivery System API

    In diesem Thema erhalten Sie einen Überblick über das Delivery System APIs, die die Verwaltung und Bereitstellung einer Gruppe von Dateien ermöglichen, die als Repository bezeichnet werden. Dieses System wurde als Speicherbereich für eingerichtet player Verwandte Dateien, wie die JavaScript- und CSS-Dateien für benutzerdefinierte Plugins.

    Überblick

    Dateien, die mit dem Delivery System verknüpft sind, werden über REST-APIs und optional über Git verwaltet. Diese Dateien werden an geliefert players.brightcove.net entweder über einen API-Aufruf oder einen "Git-Push".

    Wenn Sie nicht durch die Schritt für Schritt: Delivery System APIEs ist sehr empfehlenswert, dass du dort anfängst. Sie erhalten Sicherheitseinstellungen, lernen einige Grundlagen des Systems und sind dann bereit, hier weiter zu tauchen.

    Siehe auch die API-Referenz.

    Bereitstellungssystem-REST-APIs

    Die APIs des Bereitstellungssystems sind um Repositories zentriert, die auch als Repos bezeichnet werden. Sie können Repos über eine Gruppe von REST-APIs verwalten, mit denen Sie Ihre Repos hinzufügen, abrufen und auflisten können. Sie können REST-API-Aufrufe auch verwenden, um Dateien in Repos zu bearbeiten.

    Sie können das Befehlszeilentool curl verwenden, um die REST-APIs zu verwenden. Die REST-APIs geben Antworten im JSON-Format zurück, die folgende Informationen zum Erfolg enthalten:

    • name: Der Name des Repos. Dies ist derselbe Name wie in den REST-API-URLs.
    • public_url: Die Basis-URL, unter der die Repo-Dateien angezeigt werden.

    Das Schritt für Schritt: Liefersystem bietet eine praktische Anleitung zur Verwendung der Delivery System APIs.

    Beglaubigung

    Sie können sich selbst autorisieren OAuth-Zugriffstoken oder über die Standardauthentifizierung mit Ihrem Brightcove-Benutzernamen und -Kennwort. Die Standard-OAuth-Zugriffstoken sollten für jede programmgesteuerte Verwendung der APIs verwendet werden. Die Standardauthentifizierungsroute ist jedoch für die Verwendung in der Befehlszeile und für den Einstieg viel einfacher.

    Wir verwenden die Standardauthentifizierung in der Schritt-für-Schritt Beispiele. Wenn Sie stattdessen Zugriffstokens verwenden möchten, ändern Sie Folgendes:

        --user $EMAIL

    zu:

        --header "Authorization: Bearer $ACCESS_TOKEN"

    API-Fehlerreaktionen

    Es gibt eine Reihe möglicher Fehlerreaktionen, die im JSON-Format zurückgegeben werden können, wenn ein Problem mit einem REST-API-Aufruf auftritt:

    • Wenn Sie versuchen, eine API aufzurufen, die nicht vorhanden ist, einschließlich falsch geschriebener API-Aufrufe, erhalten Sie einen Statuscode von 404 und eine hilfreiche Nachricht darüber, was Sie möglicherweise falsch gemacht haben.
    • Wenn Ihr Anruf nicht authentifiziert oder autorisiert werden kann, erhalten Sie einen 403-Statuscode. Versuchen Sie, den OAuth-Leitfaden erneut zu lesen, um sicherzustellen, dass Sie über ein gültiges Zugriffstoken verfügen.
    • Wenn Sie versuchen, eine andere Methode als GET oder PUT zu verwenden, enthält die Antwort einen 405-Statuscode.
    • Wenn bei der Bearbeitung Ihrer Anfrage ein Problem auftritt, erhalten Sie einen 500-Statuscode und eine Standard-Brightcove-Fehlerantwort.

    Die oben erwähnte Standard-Brightcove-Fehlerantwort ist eine JSON-Antwort, die error_code und Nachrichteneigenschaften enthält. Der Fehlercode lautet wie folgt:

    • INVALID_LOGIN_CREDENTIALS: Der Benutzername und das Passwort bei der Verwendung der Standardauthentifizierung waren nicht gültig
    • ACCESS_TOKEN_ERROR: Das angegebene Zugriffs-Token war nicht gültig
    • INVALID_API_CALL: Der API-Aufruf wurde nicht ordnungsgemäß formatiert
    • NOT_FOUND: Der API-Aufruf zeigte nicht auf eine bekannte Ressource oder wurde nicht ordnungsgemäß formatiert
    • NO_PUT_CONTENTS: Ein mehrteiliges Formular mit einem Inhaltsschlüssel muss verwendet werden, um eine Repo-Datei zu PUT
    • CREATE_REPO_ERROR: Beim Erstellen eines Repos ist ein Fehler aufgetreten
    • GET_REPO_ERROR: Beim Abrufen eines Repos ist ein Fehler aufgetreten
    • GET_REPOS_ERROR: Beim Abrufen aller Repos ist ein Fehler aufgetreten
    • UNCAUGHT_ERROR: Ein nicht erfasster Fehler hat die Fehler verursacht
    • UNKNOWN_ERROR: Es ist ein Fehler aufgetreten, dem kein Fehlercode zugeordnet ist

    Einschränkungen


    Seite zuletzt aktualisiert am 28