Support Kontakt Support | Systemstatus Systemstatus

Verwenden Sie Insomnia für API-Anfragen

In diesem Thema erfahren Sie, wie Sie den beliebten Insomnia HTTP-Client so einrichten, dass Anforderungen an die Brightcove RESTful-APIs gestellt werden.

Einführung

Einige finden Curl-Anweisungen und die Befehlszeile, die für viele Beispiele in unserer Plattform-API-Dokumentation verwendet werden, schwierig und einschüchternd. Für diese gibt es zahlreiche Tools zum Senden von HTTP-Anforderungen an REST-basierte Dienste, einschließlich der meisten Brightcove-APIs. Dieses Dokument zeigt Ihnen, wie Sie ein beliebtes Tool verwenden, das Insomnia App.

installieren Insomnia

Erhalte Insomnia von der https://insomnia.rest. Insomnia Kann auf Mac-, Linux- oder Windows-Systemen installiert werden.

Insomnia kann verwendet werden, um Anforderungen an eine der RESTful-APIs von Brightcove zu stellen. Die meisten APIs verwenden OAuth2 zur Authentifizierung. Dies wird in diesem Dokument demonstriert. Sie können es jedoch auch für APIs verwenden, die OAuth nicht verwenden, indem Sie einfach den entsprechenden Header festlegen.

Kopfzeile in Insomnia setzen
Setze Header in Insomnia

So sieht der Header für Anfragen mit unterschiedlichen Authentifizierungsmethoden aus:

OAuth API (Credentials-Anfrage erstellen ausschließlich )
  Authorization: BC_TOKEN YOUR_BC_TOKEN

Wie bekommen Sie Ihre BC_TOKEN.

Playback API
  BCOV-Policy: YOUR_POLICY_KEY
Live API
  X-API-KEY: YOUR_API_KEY
Zencoder API
  Zencoder-Api-Key: YOUR_API_KEY

Client-Anmeldeinformationen abrufen

Um mit den meisten Brightcove-APIs arbeiten zu können, benötigen Sie Client-Anmeldeinformationen für das Konto und die APIs, die Sie verwenden möchten. Holen Sie sich Ihre Client-Anmeldeinformationen in Studio, indem Sie den Anweisungen in folgen API-Authentifizierungsdaten verwalten. In den folgenden Schritten werden wir machen Player Management API Anfragen mit InsomniaDaher sollten Ihre Anmeldeinformationen mindestens die folgenden Berechtigungen aufweisen:

  • Players: Lesen Schreiben

Sie können so viele zusätzliche Berechtigungen hinzufügen, wie Sie möchten, um Anmeldeinformationen zu erhalten, die für einen größeren Bereich von API-Anforderungen verwendet werden können. Beachten Sie außerdem, dass Sie Anmeldeinformationen erhalten können, die für mehrere Konten funktionieren, wenn Sie möchten.

Es ist recht schwierig viele Produkte gleichzeitig zu verwenden und auch hintereinander aufzutragen. Die Wirkstoffe können nicht alle gleichzeitig aufgenommen werden und die Haut ist schließlich überfordert. Die Folge könnten Hautrötungen und Unverträglichkeiten sein. Insomnia

Sobald Sie Ihre Client-Anmeldeinformationen haben, können Sie mit der Verwendung beginnen Insomnia. Die folgenden Schritte führen Sie durch einige Player Management API Anfragen mit Insomnia.

Einrichten eines Insomnia Arbeitsplatz

Wenn Sie mit anderen APIs arbeiten, möchten Sie möglicherweise einen Arbeitsbereich nur für Brightcove-Anforderungen erstellen.

  1. Starten Sie die Insomnia App.
  2. Klicken Sie auf das Dropdown-Menü neben Insomnia und wählen Sie Neuer Arbeitsbereich:
    Erstellen Sie Arbeitsbereich
    Insomnia Autorisierungsabschnitt
  3. Geben Sie den Namen ein Brightcove und klicken auf Erstellen:
    Name Arbeitsbereich
    Autorisierungstyp
  4. Klicken Sie auf die Pluszeichen und wählen Sie Neuer Ordner:
    Neuen Ordner erstellen
    Neuen Ordner erstellen
  5. Geben Sie Ihrem Ordner den Namen Player Management API

Senden GET Anforderung

Jetzt sind wir bereit, einige API-Anfragen zu machen.

Mach ein GET Anforderung

  1. Klicken Sie auf das Dropdown-Menüsymbol in Ihrem neuen Ordner und wählen Sie Neue Anfrage:
    Neue Anfrage
    Neue Anfrage
  2. Gib der Anfrage den Namen Nimm alle Players, belassen Sie die HTTP-Methode als GET, und klicken Sie auf Erstellen.
  3. Ersetzen Sie die generische Anforderungs-URL durch:
      https://players.api.brightcove.com/v2/accounts/account_id/players

    Ersetzen Konto_ID mit Ihrer eigenen Konto-ID:

    Neue Anfrage
    Neue Anfrage
  4. Erweitern Sie die Auth Dropdown-Menü und wählen Sie OAuth 2.0:
    Authentifizierungsmenü
    Authentifizierungsmenü
  5. Für die ErteilungsartWählen Kundenanmeldeinformationen:
    Erteilungsart
    Erteilungsart
  6. Geben Sie Werte für die Zugriffstoken-URL, die Client-ID und das Client-Geheimnis ein:
    OAuth-Einträge
    Zugriffstoken-URL https://oauth.brightcove.com/v4/access_token
    Kunden-ID Ihre Kunden-ID
    Kundengeheimnis Ihr Kundengeheimnis
  7. Eine detaillierte Token abrufen um sicherzustellen, dass das funktioniert. Sie sollten eine Antwort wie folgt sehen:
    Zugangstoken
    Zugangstoken
  8. Eine detaillierte Senden:
    GET Anfrage
    GET Ihre Anfrage
  9. Die Antwort sollte etwa so aussehen:
    Erhalten Antwort
    GET Antwort

Senden POST Anforderung

Jetzt werden wir eine senden POST Anfrage mit einigen Daten. In diesem Fall erstellen wir ein neues Videoobjekt mit dem Player Management API.

Um dies zu tun, werden wir die Nimm alle Players Anfrage und ändern, wie wir müssen. Eine weitere nette Eigenschaft von Insomnia Wenn du eine Anfrage duplizierst, werden alle Authentifizierungsinformationen mit ihr dupliziert, so dass du nicht erneut Zugangspunkte beschaffen musst.

Mach ein POST Anforderung

  1. Klicken Sie auf Player Management API Ordner zum Anzeigen der Nimm alle Players Anfrage drinnen.
  2. Erweitern Sie das Dropdown-Menü für Nimm alle Players anfragen und auswählen Duplikat:
    Doppelte Anfrage
    Doppelte Anfrage
  3. Doppelklicken Sie auf den Namen Nimm alle Players (Kopie) und ändern Sie sie Erstellen Player
  4. Verwenden Sie die gleiche URL wie für die obigen GET-Anforderungsschritte, wählen Sie aber jetzt POST um die ausgewählte HTTP-Methode zu sein.
    Ändere Methdo
    Ändern Sie die Methode
  5. Klicken Sie auf die Körper um das Dropdown-Menü zu erweitern und auszuwählen JSON:
    Wählen Sie Körpertyp
    Wählen Sie Körpertyp
  6. Für die Körper Geben Sie den folgenden JSON-Code für den Body ein (der Screenshot nach JSON zeigt, wie die Anfrage aussehen soll):
      {
      "name": "MySamplePlayer",
          "configuration": {
              "media": {
              "sources": [{
                  "src":"http://solutions.brightcove.com/bcls/assets/videos/Tiger.mp4",
                  "type":"video/mp4"
                  }]
              }
          }
      }
      
      
      {
          "name": "MySamplePlayer",
          "configuration": {}
      }
      
      
    Anfragetext
    Anfragetext
    Anfragetext
    Anfragetext
  7. Eine detaillierte Senden.
  8. Ihre Antwort sieht etwa wie folgt aus (Sie können auf die Schaltfläche klicken Ziemlich Taste für schön formatiertes JSON):

    POST-Antwort
    POST Antwort
  9. Sie können überprüfen, ob Ihre player wurde durch Einchecken in erstellt Players Modul in Studio.

Umgebungsvariablen

Vielleicht finden Sie es hilfreich zu verwenden Insomnia's Environments zum Speichern von OAuth-Anmeldeinformationen für verschiedene APIs oder zum Speichern anderer Informationen wie Ihrer Konto-ID und Ihres Videos oder player IDs.

Im Folgenden sind die Schritte zum Erstellen und Verwenden von Umgebungsvariablen für die client_id , client_secret und account_id.

  1. Eine detaillierte Keine Umgebungen im oberen linken Bereich von Insomnia um das Dropdown-Menü zu erweitern und auszuwählen Umgebungen verwalten
    Menü "Umgebungen"
    Menü "Umgebungen"
  2. In dem Umgebungen verwalten Klicken Sie auf das Dialogfeld + Zeichen neben Sub-Umgebungen um das Dropdown-Menü zu erweitern, und wählen Sie Umwelt um eine neue Umgebung zu schaffen:
    Fügen Sie Umgebung hinzu
    Fügen Sie Umgebung hinzu
  3. Auf der Doppel-klicken Neue Umgebung Name, um es zu ändern Player Management API (oder was auch immer du magst).
  4. Fügen Sie in den geschweiften Klammern für die Umgebungs-JSON diese Schlüssel / Wert-Paare hinzu:
    • "account_id""Ihre Konto-ID"
    • "client_id""Ihre Kunden-ID"
    • "client_secret""Ihr Kundengeheimnis"

    Wenn Sie fertig sind, sollte der JSON wie folgt aussehen:

    Fügen Sie Umgebungs-JSON hinzu
    Fügen Sie Umgebungs-JSON hinzu

    (Das Client-Geheimnis hier ist aus Sicherheitsgründen verwischt.)

  5. Eine detaillierte Gemacht um die Umgebung hinzuzufügen
  6. Eine detaillierte Keine Umgebung Klicken Sie erneut auf das Dropdown-Menü und wählen Sie Anwenden Player Verwaltungsumgebung (oder welchen Namen auch immer du der neuen Umgebung gegeben hast):
    Wählen Sie Umgebung
    Wählen Sie Umgebung
  7. Wählen Sie nun das Nimm alle Players Fordern Sie es erneut an, es erneut zu öffnen.
  8. Eine detaillierte OAuth 2 um den Authentifizierungsabschnitt erneut zu öffnen.
  9. Löschen Sie den Wert der Client-ID und beginnen Sie mit der Eingabe client_id - Sie sehen ein Dropdown-Menü mit relevanten Umgebungsvariablen, die Sie auswählen sollten client_id:
    Dropdown-Liste der Umgebungsvariablen
    Dropdown-Liste der Umgebungsvariablen
  10. Wählen Sie nun das Konto-ID in der Anforderungs-URL und ersetzen Sie sie durch die Konto_ID variabel.
  11. Tun Sie dasselbe, um das zu ersetzen Kundengeheimnis Wert mit dem Client_Secret variabel.
  12. Klicken Sie nun auf Senden erneut, um sicherzustellen, dass die Anfrage immer noch funktioniert.

Fazit

Sie kennen jetzt die Grundlagen der Verwendung Insomnia um Anforderungen an die Brightcove-APIs zu stellen. Beachten Sie dies, wenn Sie sich für ein kostenloses Upgrade entscheiden Insomnia Konto zu einem Team-Konto, können Sie auch alle Ihre Anfragen und Umgebungen synchronisieren und sie mit anderen Teammitgliedern teilen.


Seite zuletzt aktualisiert am 12. Juni 2020