Überblick
Mit dem Bereitstellungssystem verknüpfte Dateien werden über REST-APIs und optional über Git verwaltet. Diese Dateien werden geliefert an player.brightcove.net entweder durch einen API-Aufruf oder einen "git push".
Wenn Sie nicht durch die gegangen sind Schritt für Schritt: Delivery System API, es wird dringend empfohlen, dort zu beginnen. Sie werden die Sicherheit einrichten, einige der Grundlagen des Systems erlernen und dann bereit sein, hier weiter einzutauchen.
Siehe auch die API-Referenz.
Bereitstellungssystem-REST-APIs
Die APIs des Bereitstellungssystems sind um Repositorys herum zentriert, auch bekannt als Repositorys. Sie können Repositorys über eine Gruppe von REST-APIs verwalten, mit denen Sie Ihre Repositorys hinzufügen, abrufen und auflisten können. Sie können auch REST-API-Aufrufe verwenden, um Dateien in Repositorys 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 die folgenden Erfolgsinformationen enthalten:
- Name: Der Repository-Name. Dies ist der gleiche Name wie in den REST-API-URLs.
- öffentliche_url: Die Basis-URL, unter der die Repository-Dateien angezeigt werden können.
Die Schritt für Schritt: Liefersystem bietet eine praktische Anleitung zur Verwendung der Delivery System APIs.
Authentifizierung
Sie können sich mit beiden 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, aber die Basisauthentifizierungsroute ist für die Befehlszeilenverwendung und den Einstieg viel einfacher.
Wir verwenden die Standardauthentifizierung im Schritt für Schritt Beispiele. Wenn Sie stattdessen Zugriffstoken verwenden möchten, ändern Sie Folgendes:
--user $EMAIL
zu:
--header "Authorization: Bearer $ACCESS_TOKEN"
API-Fehlerantworten
Es gibt eine Reihe möglicher Fehlerantworten, die im JSON-Format zurückgegeben werden können, wenn ein Problem mit einem REST-API-Aufruf auftritt:
- Wenn Sie versuchen, eine nicht vorhandene API aufzurufen, einschließlich der Schreibfehler vorhandener API-Aufrufe, erhalten Sie den Statuscode 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. Gehen Sie den OAuth-Leitfaden erneut durch, 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 Verarbeitung Ihrer Anfrage ein Problem auftritt, erhalten Sie einen 500-Statuscode und eine standardmäßige Brightcove-Fehlerantwort.
Die oben erwähnte standardmäßige Brightcove-Fehlerantwort ist eine JSON-Antwort, die error_code und Nachrichteneigenschaften enthält. Der Fehlercode ist einer der folgenden:
INVALID_LOGIN_CREDENTIALS: Der Benutzername und das Passwort, die bei der Verwendung der Standardauthentifizierung angegeben wurden, waren nicht gültigACCESS_TOKEN_ERROR: Das angegebene Zugriffstoken war nicht gültigINVALID_API_CALL: der API-Aufruf wurde nicht richtig formatiertNOT_FOUND: Der API-Aufruf zeigte nicht auf eine bekannte Ressource oder wurde nicht richtig formatiert- :
NO_PUT_CONTENTSZum PUT einer Repo-Datei muss ein mehrteiliges Formular mit einem Inhaltsschlüssel verwendet werden CREATE_REPO_ERROR: Beim Erstellen eines Repositorys ist ein Fehler aufgetretenGET_REPO_ERROR: Beim Abrufen eines Repositorys ist ein Fehler aufgetretenGET_REPOS_ERROR: Beim Abrufen aller Repos ist ein Fehler aufgetretenUNCAUGHT_ERROR: ein nicht erkannter Fehler führte zum Scheitern von DingenUNKNOWN_ERROR: ein Fehler ohne zugehörigen Fehlercode ist aufgetreten