Einführung
Der Ingest Profiles API erlaubt dir zu:
-
Holen Sie sich die Profile für Ihr Konto
-
Erstellen Sie neue Profile
-
Profile aktualisieren
-
Löschen Sie Profile
-
Legen Sie das Standardprofil für Ihr Konto fest oder aktualisieren Sie es
Eine erholsame API
Der Ingest Profiles API ist eine RESTful-API. Es akzeptiert HTTPS-Anforderungen und gibt eine JSON-Antwort zurück.
Dies bedeutet, dass Sie die API mit jeder beliebigen Sprache verwenden können - Ruby, Java, PHP, Python, JavaScript (über AJAX oder Nodejs) usw. Alles, was Sie tun müssen, ist, HTTPS-Anfragen zu stellen und eine JSON-Antwort zu bearbeiten.
Die Basis-URL
Die Basis-URL für die Ingest Profiles API ist:
https://ingestion.api.brightcove.com/v1
Genehmigung
API-Aufrufe werden mithilfe von OAuth2-Zugriffstoken autorisiert. Das Token wird mit Anforderungen in einem Berechtigungsheader übergeben:
Authorization: Bearer {access_token}
Zugriffstoken sind Kurz-lived (5 min), daher müssen Sie jedes Mal eine erhalten, wenn Sie eine Anfrage stellen
In diesen Übungen stellen wir Anfragen über ein Stellvertreter Das wird ein Zugriffs-Token abrufen und dann die Anfrage machen.
Setup für die Übungen
Einrichtung
Sie haben zwei Möglichkeiten:
- Führen Sie die Übungen auf einem Beispielkonto durch (empfohlen)
- Verwenden Sie Ihr eigenes Konto
Alle Profile abrufen
Abrufen der Kontoprofile
Um alle Profile für ein Konto abzurufen, führen Sie eine GET-Anforderung an den Endpunkt aus:
/accounts/{account_id}/profiles
Beispiel:
https://ingestion.api.brightcove.com/v1/accounts/57838016001/profiles
Übung 1: Holen Sie sich alle Profile
Machen Sie die folgende GET-Anfrage:
Ein Profil erstellen
Erstellen von Profilen
Um ein Profil zu erstellen, führen Sie eine POST-Anforderung an den Endpunkt aus:
/accounts/{account_id}/profiles
Beispiel:
https://ingestion.api.brightcove.com/v1/accounts/57838016001/profiles
Der JSON für das Profil ist als Anfragetext enthalten. Siehe die Profilfeldreferenz für Profil-, Wiedergabe- und DRM-Paketfelder
Übung 2: Erstellen Sie ein Profil
Nehmen Sie die folgende POST-Anfrage vor:
Übung 2-Antwort
Ein einzelnes Profil erhalten
Ein Profil von ID erhalten
Um ein Profil nach ID abzurufen, führen Sie eine GET-Anforderung an den Endpunkt aus:
/accounts/{account_id}/profiles/{profile_id}
Für die profile_id
Sie können entweder Folgendes verwenden:
- Name (zB balanced-high-definition)
- generated id (e.g. 54de14cce4b0a6d2bf9cb08a)
Beispiele:
https://ingestion.api.brightcove.com/v1/accounts/57838016001/profiles/screencast
https://ingestion.api.brightcove.com/v1/accounts/57838016001/profiles/54de14cce4b0a6d2bf9cb08a
Übung 3: Holen Sie sich ein Profil
Nehmen Sie die folgende GET-Anforderung vor, um das von Ihnen erstellte Profil wiederherzustellen:
Aktualisieren eines Profils
Aktualisieren Sie ein Profil nach ID
Um ein Profil nach ID zu aktualisieren, machen Sie eine PUT-Anfrage an den Endpunkt:
/accounts/{account_id}/profiles/{profile_id}
Für die profile_id
Sie können entweder Folgendes verwenden:
- Name (zB balanced-high-definition)
- generated id (e.g. 54de14cce4b0a6d2bf9cb08a)
Beispiel:
https://ingestion.api.brightcove.com/v1/accounts/57838016001/profiles/my-test-profile
Schließen Sie die Profildaten wie bei der Erstellung des Profils in den Anfragetext ein. Die Profildaten sollen umfassen die id
für das Profil!
Übung 4: Profil aktualisieren
Nehmen Sie die folgende PUT-Anfrage vor, um das von Ihnen erstellte Profil zu aktualisieren (die Beschreibung wird aktualisiert):
Übung 4-Antwort
Löschen eines Profils
Löschen Sie ein Profil nach ID
Um ein Profil nach ID zu löschen, machen Sie eine DELETE-Anfrage an den Endpunkt:
/accounts/{account_id}/profiles/{profile_id}
Für die profile_id
Sie können entweder Folgendes verwenden:
- Name (zB balanced-high-definition)
- generated id (e.g. 54de14cce4b0a6d2bf9cb08a)
Beispiel:
https://ingestion.api.brightcove.com/v1/accounts/57838016001/profiles/my-test-profile
Übung 5: Profil löschen
Nehmen Sie die folgende DELETE-Anfrage vor, um das erstellte Profil zu aktualisieren (nicht rückgängig zu machen!):
Standardprofil erhalten
Holen Sie sich das Standardprofil
Um das Standardprofil für das Konto abzurufen, führen Sie eine GET-Anforderung an den Endpunkt aus:
/accounts/account_id/configuration
Beispiel:
https://ingestion.api.brightcove.com/v1/accounts/57838016001/configuration
Übung 6: Ruft das Standardprofil ab
Nehmen Sie die folgende GET-Anforderung vor, um das Standardprofil für das Konto zu erhalten:
Standardprofil festlegen
Legen Sie das Standardprofil fest
Um das Standardprofil für das Konto festzulegen, führen Sie eine POST-Anforderung an den Endpunkt aus:
/accounts/account_id/configuration
Fügen Sie diesen JSON als Anfragetext ein
{
"account_id": {account_id},
"default_profile_id": {default_profile_id}
}
Wie bei anderen Operationen können Sie den Namen oder die ID für die profile_id
.
- Name (zB balanced-high-definition)
- generated id (e.g. 54de14cce4b0a6d2bf9cb08a)
Beispiel:
https://ingestion.api.brightcove.com/v1/accounts/57838016001/configuration
Übung 7: Setze das Standardprofil
Machen Sie die folgende POST-Anfrage, um das Standardprofil festzulegen (beachten Sie, dass dies fehlschlägt, wenn das Konto bereits ein Standardprofil hat - wir werden den Standard in der nächsten Übung aktualisieren):
Übung 7-Antwort
Standardprofil aktualisieren
Aktualisieren Sie das Standardprofil
Um das Standardprofil für das Konto zu aktualisieren, stellen Sie eine PUT-Anforderung an den Endpunkt:
/accounts/account_id/configuration
Fügen Sie diesen JSON als Anfragetext ein
{
"id": {configuration_id},
"account_id": {account_id},
"default_profile_id": {default_profile_id}
}
Die Konfigurations-ID wird zurückgegeben, wenn Sie das Standardprofil erhalten. Wenn kein Standardprofil vorhanden ist, siehe Festlegen des Standardprofils. Wie bei anderen Operationen können Sie den Namen oder die ID für die profile_id
.
- Name (zB hochauflösend)
- generated id (e.g. 54de14cce4b0a6d2bf9cb08a)
Beispiel:
https://ingestion.api.brightcove.com/v1/accounts/57838016001/configuration
Übung 8: Standardprofil aktualisieren
Nehmen Sie die folgende PUT-Anforderung vor, um das Standardprofil für das Konto zu aktualisieren: