Grundlegende API-Funktionen von Cisco Meeting Server

Einführung

Dieses Dokument beschreibt die vier grundlegenden API-Funktionen GET, POST, PUT und DELETE, die auf CMS (Cisco Meeting Server) verwendet werden. Ab CMS 2.9 bietet die GUI für Webadministratoren ein API-Menü, das im Konfigurationsmenü verfügbar ist. In diesem Dokument wird das neue Menü erläutert. Darüber hinaus werden zwei verschiedene API-Tools beschrieben: Poster und Postman und deren Verwendung für die CMS-Konfiguration.

Voraussetzungen

Anforderungen

Es gibt keine spezifischen Anforderungen für dieses Dokument.

Verwendete Komponenten

Dieses Dokument ist nicht auf bestimmte Software- und Hardware-Versionen beschränkt.

Die Informationen in diesem Dokument können mit CMS 2.9 und höher oder mit verschiedenen API-Clients wie Postman oder Poster verwendet werden. Diese Tools von Drittanbietern werden im Abschnitt API-Clients des Dokuments beschrieben.

Die Informationen in diesem Dokument beziehen sich auf Geräte in einer speziell eingerichteten Testumgebung. Alle Geräte, die in diesem Dokument benutzt wurden, begannen mit einer gelöschten (Nichterfüllungs) Konfiguration. Wenn Ihr Netz Live ist, überprüfen Sie, ob Sie die mögliche Auswirkung jedes möglichen Befehls verstehen.

Hintergrundinformationen

Die API für das CMS ist eine extrem flexible Möglichkeit, viele seiner Funktionen zu konfigurieren. Es gibt viel zu viele API-Funktionen, die Sie sich merken oder hier abdecken sollten. Verweisen Sie daher auf die aktuelle API-Referenzdokumentation. Zum Zeitpunkt dieser Veröffentlichung sind die aktuellen API-Referenzhandbücher hier verfügbar.

API-Anforderung und -Antwort

API-Kommunikation ist eine Beziehung zwischen Clients und Servern zur Reaktion auf Anfragen. Der Client stellt eine Anfrage an den Server. Nach Bearbeitung der Anfrage (Abschluss einer Aktion oder Ablehnung einer Aktion) wird eine Antwort zurückgegeben.

Die vier in diesem Artikel beschriebenen Anträge sind:

1. GET - Abrufen vorhandener Informationen
2. POST - Erstellt neue Informationen
3. PUT - Ändert vorhandene Informationen
4. LÖSCHEN - Löscht vorhandene Informationen.

Dies sind die grundlegenden API-Anforderungen für die Konfiguration des CMS.

Die häufigste Antwort ist ein 200 OK. Weitere Antworten sind 4xx und 5xx, d. h. Fehlerantworten.

Konfiguration

CMS 2.9 und höher

CMS 2.9 hat ein neues API-Menü eingeführt, das es Administratoren deutlich erleichtert, Einstellungen zu ändern und Einstellungen in CMS zu optimieren.  Wenn Sie das Menü verwenden, werden alle verfügbaren Parameter angezeigt, sodass Einstellungen schnell und einfach geändert und neue Funktionen aktiviert werden können.

Konfigurieren eines API-Objekts

Im API-Menü können Sie die API-Objekte auf das filtern, was Sie bearbeiten/erstellen möchten, und dann auf den schwarzen Pfeil neben dem Objekt klicken, um diese Änderungen vorzunehmen. In diesem Beispiel wird veranschaulicht, wie callLegProfiles nachgeschlagen und ein neues callLegProfile erstellt wird.

Wenn Sie auf Create New (Neu erstellen) klicken, wird dieser Bildschirm angezeigt, in dem alle verfügbaren Parameter für CallLegProfiles angezeigt werden. Wenn Sie den Mauszeiger über einen bestimmten Parameter bewegen, wird ein Popup-Fenster mit dem Zweck der einzelnen Optionen angezeigt.

Ändern eines bereits erstellten API-Objekts

Wenn Sie die Einstellungen in einem Objekt ändern, sehen Sie unten die Schaltfläche Ändern. Dies entspricht einem PUT von Drittanbieter-Tools.

Löschen eines API-Objekts aus dem API-Menü

Um ein Objekt zu löschen, können Sie auf der Hauptseite Objektliste das Löschen von Elementen aktivieren. Klicken Sie auf Löschen zulassen, um die Option zum Löschen zu aktivieren, wie in diesem Beispiel gezeigt:

Erklärte API-Anforderungen (mithilfe von Drittanbieter-Tools)

Die vier grundlegenden Anforderungen werden in einem Konfigurationsbeispiel erläutert.

HTTP POST

Schritt 1: Verwenden Sie POST, um ein Objekt zu erstellen.

In diesem Beispiel wird mit dieser Anforderung ein CMS-Bereich erstellt. Informationen zum Erstellen des Space über API finden Sie in der API-Dokumentation. In diesem Beispiel habe ich den API-Leitfaden für CMS 2.4 verwendet. Sie sollten jedoch die neuesten API-Leitfäden verwenden, die hier zu finden sind.

Abschnitt 6.2 enthält Informationen zum Erstellen und Ändern von Leerzeichen.

Der erste Satz besagt, dass Sie einen Beitrag an /coSpaces senden müssen, um einen Space zu erstellen. Anschließend wird die ID des Space im Location-Header des 200 OK angegeben. Großartig, Sie wissen jetzt, wie man einen Raum erschafft. Sie senden einfach einen POST an https://<WebAdminIP>/api/v1/coSpaces.

Geben Sie die Parameter für den POST-Test an.

In Abschnitt 6.2 der Dokumentation sehen Sie eine Tabelle mit allen Parametern, die Sie verwenden können.

Beispiele: Erstellen Sie ein Leerzeichen mit dem Namen APITest und einem URI-Benutzerpart von APITestURI.

Der Inhaltstyp ist application/x-www-form-urlencoded und der Inhalt ist name=APITest&uri=APITestURI.

Wenn Sie diese Parameter hinzufügen, ist die Anforderung abgeschlossen, wie im Bild gezeigt.

POST https://<WebAdminIP>/api/v1/coSpaces HTTP/1.1
Host: <WebAdminIP>
Content-Type: application/x-www-form-urlencoded
Content-Length: 27
Authorization: Basic YWRtaW46QzFzYzBDMXNjMA==
Connection: keep-alive

name=APITest&uri=APITestURI

Das Bild zeigt eine Antwort auf die vorherige Anforderung.

HTTP/1.1 200 OK
Server: Apache
X-Frame-Options: DENY
Strict-Transport-Security: max-age=31536000; includeSubDomains
Location: /api/v1/coSpaces/70ca0ed7-4e50-428c-b9ab-4e68faeb86ae
Vary: Accept-Encoding
Content-Encoding: gzip
Keep-Alive: timeout=5, max=100
Connection: Keep-Alive
Transfer-Encoding: chunked

Beachten Sie den Location-Header in der Antwort.

Location: /api/v1/coSpaces/70ca0ed7-4e50-428c-b9ab-4e68faeb86ae

70ca0ed7-4e50-428c-b9ab-4e68faeb86ae ist die ID des neu erstellten Raumes. Die ID ist nützlich, wenn Sie zukünftige API-Anfragen erstellen müssen, die auf denselben Speicherplatz abzielen.

Der Leerraum ist im WebAdmin von CMS sichtbar. Navigieren Sie zu Konfiguration > Leerzeichen.

Das Bild fasst den POST-Test für die Anforderung zusammen.

HTTP GET

Schritt 2: Nachdem der Leerraum erstellt wurde, ziehen Sie die entsprechende Konfiguration ab.

Verwenden Sie hierfür die HTTP GET-Methode.

Verwenden Sie die ID für den aus dem Location-Header erstellten Leerraum. Die URL lautet https://<WebAdminIP>/api/v1/coSpaces/70ca0ed7-4e50-428c-b9ab-4e68faeb86ae.  Führen Sie auf dieser Seite ein GET durch.

Beispiel für eine GET-Anforderung:

GET https://<WebAdminIP>/api/v1/coSpaces/70ca0ed7-4e50-428c-b9ab-4e68faeb86ae HTTP/1.1
Host: <WebAdminIP>
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64; rv:45.0) Gecko/20100101 Firefox/45.0
Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
Accept-Language: en-US,en;q=0.5
Accept-Encoding: gzip, deflate, br
Cookie: session=logout
Authorization: Basic YWRtaW46QzFzYzBDMXNjMA==
Connection: keep-alive

Antwort auf GET-Anforderung:

HTTP/1.1 200 OK
Server: Apache
X-Frame-Options: DENY
Strict-Transport-Security: max-age=31536000; includeSubDomains
Content-Type: text/xml
Vary: Accept-Encoding
Content-Length: 159
Keep-Alive: timeout=5, max=100
Connection: Keep-Alive

<?xml version="1.0"?><coSpace id="70ca0ed7-4e50-428c-b9ab-4e68faeb86ae"><name>APITest</name><autoGenerated>false</autoGenerated><uri>apitesturi</uri></coSpace>

Hinweis: Die Antwort ist eine XML-codierte Konfiguration des Space.

Das Bild fasst die Anforderung GET zusammen.

HTTP-PUT

Schritt 3: Ändern Sie ggf. das Leerzeichen.

In diesem Beispiel wird veranschaulicht, wie der erstellte Speicherplatz geändert wird. Stellen Sie sich vor, Sie müssten einen Teil des zweiten Benutzers zum Leerzeichen hinzufügen.

Weitere Informationen finden Sie im API-Dokument. Der erforderliche Parameter lautet wie folgt: SekundärUri.

Fügen Sie einen URI mit ASDF hinzu. Schreiben Sie eine Anforderung, die der für den POST-Test erstellten Anforderung ähnelt.

PUT-Beispielanforderung:

PUT https://172.18.105.244/api/v1/coSpaces/70ca0ed7-4e50-428c-b9ab-4e68faeb86ae HTTP/1.1
Host: 172.18.105.244
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64; rv:45.0) Gecko/20100101 Firefox/45.0
Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
Accept-Language: en-US,en;q=0.5
Accept-Encoding: gzip, deflate, br
Content-Type: application/x-www-form-urlencoded
Content-Length: 17
Cookie: session=b810c447daaeab6cdc6e019c
Authorization: Basic YWRtaW46QzFzYzBDMXNjMA==
Connection: keep-alive

secondaryUri=asdf

Antwort für die PUT-Anforderung:

HTTP/1.1 200 OK
Date: Tue, 12 Apr 2016 19:11:02 GMT
Server: Apache
X-Frame-Options: DENY
Strict-Transport-Security: max-age=31536000; includeSubDomains
Vary: Accept-Encoding
Keep-Alive: timeout=5, max=100
Connection: Keep-Alive
Content-Length: 0

Die Änderungen sind im WebAdmin von CMS sichtbar. Navigieren Sie zu Konfiguration > Leerzeichen.

und über ein GET:

<?xml version="1.0"?><coSpace id="70ca0ed7-4e50-428c-b9ab-4e68faeb86ae"><name>APITest</name><autoGenerated>false</autoGenerated><uri>apitesturi</uri><secondaryUri>asdf</secondaryUri></coSpace>

Das Bild fasst die Anforderung PUT zusammen.

HTTP LÖSCHEN

Schritt 4: Löschen Sie ggf. den Speicherplatz.

Die DELETE-Methode ähnelt der GET-Methode.

DELETE-Beispielanforderung:

DELETE https://172.18.105.244/api/v1/coSpaces/70ca0ed7-4e50-428c-b9ab-4e68faeb86ae HTTP/1.1
Host: 172.18.105.244
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64; rv:45.0) Gecko/20100101 Firefox/45.0
Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
Accept-Language: en-US,en;q=0.5
Accept-Encoding: gzip, deflate, br
Cookie: session=4d13c7ebe739b662dc6e019c
Authorization: Basic YWRtaW46QzFzYzBDMXNjMA==
Connection: keep-alive

Antwort für die DELETE-Anfrage:

HTTP/1.1 200 OK
Date: Tue, 12 Apr 2016 19:16:37 GMT
Server: Apache
X-Frame-Options: DENY
Strict-Transport-Security: max-age=31536000; includeSubDomains
Vary: Accept-Encoding
Keep-Alive: timeout=5, max=100
Connection: Keep-Alive
Content-Length: 0

Die Änderungen sind im WebAdmin von CMS sichtbar. Navigieren Sie zu Konfiguration > Leerzeichen.

und über ein GET:

<?xml version="1.0"?><failureDetails><coSpaceDoesNotExist /></failureDetails>

Das Bild fasst die Anforderung LÖSCHEN zusammen.

API-Clients

POSTER

Das oberste Feld im Poster ist, wo Sie die URL für die Anfragen eingeben.

In den Feldern für die Benutzerauthentifizierung können Sie den Benutzernamen und das Kennwort in dieser Reihenfolge eingeben. Wenn Sie dann GET oder DELETE machen, wählen Sie die entsprechenden Schaltflächen aus. Beispiele: klicken Sie auf GET, und ein Popup-Fenster mit Ihrer Antwort wird angezeigt. Um LÖSCHEN, stellen Sie sicher, dass LÖSCHEN ausgewählt ist, und klicken Sie auf die grüne Schaltfläche.

Für POST und PUT müssen Inhalte hinzugefügt werden. Wählen Sie das Register Parameter, und fügen Sie die Namen und Werte für Ihre Parameter hinzu. Kehren Sie dann zur Schaltfläche Inhalt zurück, um die Nachricht zu senden, und wählen Sie Text aus Parameter aus.

Senden Sie Ihren POST und/oder PUT.

POSTMAN

Wählen Sie in Postman oben links im Dropdown-Feld die Methode aus, die Sie verwenden möchten, und geben Sie die Anfrage-URL ein.

Wählen Sie als Autorisierung Basic-Auth aus, und geben Sie Ihren Benutzernamen und Ihr Kennwort ein. Wählen Sie anschließend Aktualisierungsanforderung aus. Auf der Registerkarte Headers (Header) wird ein Autorisierungs-Header angezeigt.

Wenn Ihre Anfrage ein POST/PUT ist, navigieren Sie zur Registerkarte Body (Haupttext), wählen Sie x-www-form-urlencoded und geben Sie Ihre Parameter und Werte ein. Wenn Sie fertig sind, wählen Sie Senden.

Überprüfung

Die Überprüfungsmethode wird in jeder Anforderung erläutert.

Fehlerbehebung

Für diese Konfiguration sind derzeit keine spezifischen Informationen zur Fehlerbehebung verfügbar.