Verwenden Sie den Vorgang Create consumer app , um eine Verbraucheranwendung in einem bestimmten Katalog für eine Verbraucherorganisation in API Connect zu erstellen.
Verbraucheranwendung erstellen
Die create consumer app erstellt eine Verbraucheranwendung im angegebenen Katalog für eine bestimmte Verbraucherorganisation in der Instanz API Connect. Vor der Durchführung dieses Vorgangs ist eine Bestätigung des Benutzers erforderlich.
Tabelle 1. Parameter
| Parameter |
Typ |
Erforderlich |
Beschreibung |
title |
Zeichenfolge |
Erforderlich, wenn name nicht angegeben ist. |
Der angezeigte Titel der Verbraucheranwendung. |
name |
Zeichenfolge |
Erforderlich, wenn title nicht angegeben ist. |
Der eindeutige Name (Bezeichner) der Verbraucheranwendung. |
consumer_org |
Zeichenfolge |
Erforderlich |
Der Name der Verbraucherorganisation, unter der der Antrag erstellt wird. |
catalog |
Zeichenfolge |
Optionale |
Der Name des Katalogs, in dem die Verbraucheranwendung erstellt werden soll. Wenn nicht angegeben, wird standardmäßig "sandbox" verwendet. |
Sie können die folgenden Eingabeaufforderungen verwenden, um eine Verbraucheranwendung zu erstellen:
Tabelle 2. Eine Verbraucheranwendung erstellen
| Aktion |
Eingabeaufforderungen |
Befehle |
| Erstellen Sie eine Verbraucher-App |
- Erstellen Sie eine Verbraucheranwendung nach Titel (Standardkatalog: Sandbox)
create consumer app with the title test app for consumer org test-org
- Erstellen Sie eine Verbraucheranwendung nach Namen für einen bestimmten Katalog, z. B. Test
create consumer app with the name test-app for consumer org test-org in catalog test
- Erstellen Sie eine Verbraucheranwendung nach Name und Titel für einen bestimmten Katalog, z. B. Test
create consumer app with the title test app and the name test-app for consumer org test-org in catalog test
|
- Erstellen einer Consumer App nach Titel (Standardkatalog: Sandbox)
/create_consumer_app title:test app consumer_org:test-org
- Erstellen Sie eine Consumer App nach Namen für einen bestimmten Katalog, z. B. test
/create_consumer_app name:test-app consumer_org:test-org
- Erstellen Sie eine Consumer App nach Name und Titel zu einem bestimmten Katalog, z.B. Test
create_consumer_app title:test app name:test app consumer_org:test-org
|
Liste der Anmeldeinformationen für Verbraucher
Dieses Tool ermöglicht die Auflistung von Anmeldeinformationen für die angegebene Verbraucheranwendung und Verbraucherorganisation im Katalog der Instanz API Connect .
Tabelle 3. Parameter
| Parameter |
Typ |
Erforderlich |
Beschreibung |
consumer_app |
Zeichenfolge |
Ja |
Der Name der Verbraucheranwendung. |
consumer_org |
Zeichenfolge |
Ja |
Der Name der Konsumentenorganisation. |
catalog |
Zeichenfolge |
Optionale |
Der Name des Zielkatalogs. Wenn nicht angegeben, wird standardmäßig Sandbox verwendet. |
Sie können die folgenden Eingabeaufforderungen verwenden, um eine Verbraucheranwendung mit Anmeldeinformationen zu erstellen:
Tabelle 4. Anmeldedaten für Verbraucheranwendungen auflisten
| Aktion |
Eingabeaufforderungen |
Befehle |
| Anmeldeinformationen für Verbraucher auflisten |
|
Verbraucheranwendungsnachweis nach Titel auflisten (Standardkatalog: Sandbox) /list_consumer_app_credentials consumer_name:test-app consumer_org:test-org
/list_consumer_app_credentials consumer_name:test-app consumer_org:test-org catalog:test
|
Abonnement erstellen
Sie können ein Abonnement für eine Verbraucheranwendung für ein Produkt oder eine API innerhalb einer Verbraucherorganisation und eines Katalogs in der Instanz API Connect erstellen. Vor der Durchführung dieses Vorgangs ist eine Bestätigung des Benutzers erforderlich.
Tabelle 5. Parameter
| Parameter |
Typ |
Erforderlich |
Beschreibung |
api_name |
Zeichenfolge |
Erforderlich, wenn product_name nicht angegeben ist. |
Der Name der API, die abonniert werden soll. |
product_name |
Zeichenfolge |
Erforderlich, wenn api_name nicht angegeben ist. |
Der Name des Produkts, das abonniert werden soll. |
consumer_app |
Zeichenfolge |
Optionale |
Der Name der Verbraucheranwendung. Wenn nicht angegeben und nur eine Verbraucheranwendung im System vorhanden ist, wird diese Anwendung standardmäßig verwendet. |
consumer_org |
Zeichenfolge |
Optionale |
Der Name der Konsumentenorganisation. Wenn keine Angaben gemacht werden und nur eine Verbraucherorganisation im System vorhanden ist, wird diese Organisation standardmäßig verwendet. |
plan |
Zeichenfolge |
Optionale |
Der Name des für das Abonnement zu verwendenden Plans. Wenn nichts angegeben ist und das Produkt nur einen Plan enthält, wird dieser Plan standardmäßig verwendet. |
catalog |
Zeichenfolge |
Optionale |
Der Name des Zielkatalogs, in dem das Abonnement erstellt wird. Wenn nicht angegeben, wird standardmäßig "sandbox" verwendet. |
Sie können die folgenden Eingabeaufforderungen verwenden, um ein Abonnement zu erstellen:
Tabelle 6. Abonnement erstellen
| Aktion |
Eingabeaufforderungen |
Befehle |
| Abonnement erstellen |
- Ein Abonnement nach API-Name erstellen (Standardkatalog: Sandbox)
create subscription for api sample-api
- Erstellen Sie ein Abonnement nach API-Name für einen bestimmten Katalog, z. B. test
create subscription for api sample-api to catalog test
- Erstellen Sie ein Abonnement mit dem Produktnamen für einen bestimmten Katalog, z. B. Test
create subscription for product sample-product to catalog test
- Erstellen eines Abonnements nach API-Namen unter Verwendung eines bestimmten Plans für einen bestimmten Katalog
create subscription for api sample-api using plan default-plan to catalog test
- Erstellen eines Abonnements nach API-Name für eine bestimmte Verbraucheranwendung und Verbraucherorganisation für einen bestimmten Katalog
create subscription for api sample-api for consumer app test-app and consumer org test-org in catalog test
|
- Ein Abonnement nach API-Name erstellen (Standardkatalog: Sandbox)
/create_subscription api_name:sample-api
- Erstellen Sie ein Abonnement nach API-Name für einen bestimmten Katalog, z. B. test
/create_subscription api_name:sample-api catalog:test
- Erstellen Sie ein Abonnement mit dem Produktnamen für einen bestimmten Katalog, z. B. Test
/create_subscription product_name:sample-product catalog:test
- Erstellen eines Abonnements nach API-Namen unter Verwendung eines bestimmten Plans für einen bestimmten Katalog
/create_subscription api_name:sample-api plan:default-plan catalog:test
- Erstellen eines Abonnements nach API-Name für eine bestimmte Verbraucheranwendung und Verbraucherorganisation für einen bestimmten Katalog
/create_subscription api_name:sample-api consumer_app:test-app consumer_org:test-org catalog:test
|
Liste Abonnement
Sie können die Abonnements einer Anwendung in der Instanz API Connect auflisten.
Tabelle 7. Parameter
| Parameter |
Typ |
Erforderlich |
Beschreibung |
api_name |
Zeichenfolge |
Optionale |
Der Name der API. |
product_name |
Zeichenfolge |
Optionale |
Der Name des Produkts. |
consumer_app |
Zeichenfolge |
Optionale |
Der Name der Verbraucheranwendung. |
consumer_org |
Zeichenfolge |
Optionale |
Der Name der Zielorganisation. Wenn nicht angegeben, wird standardmäßig Sandbox verwendet. |
Sie können die folgenden Eingabeaufforderungen verwenden, um Abonnements aufzulisten:
Tabelle 8. Abonnement der Liste
| Aktion |
Eingabeaufforderungen |
Befehle |
| Liste Abonnement |
- Abonnements nach API-Namen auflisten (Standardkatalog: Sandkasten)
list subscriptions for api sample-api
- Auflisten von Abonnements nach API-Namen aus einem bestimmten Katalog, z. B. test
list subscriptions for api sample-api from catalog test
- Auflisten von Abonnements nach Produktnamen aus einem bestimmten Katalog, z. B. Test
list subscriptions for product sample-api from catalog test
- Auflistung der Abonnements nach Name der Verbraucheranwendung und Name der Verbraucherorganisation aus einem bestimmten Katalog
list subscriptions for consumer app test-app and consumer org test-org from catalog test
|
- Abonnement nach API-Name auflisten (Standardkatalog: Sandbox)
/list_subscriptions api_name:sample-api
- Liste der Abonnements nach API-Namen für einen bestimmten Katalog, z. B. test
/list_subscriptions api_name:sample-api catalog:test
- Auflistung der Abonnements nach Produktnamen für einen bestimmten Katalog, z. B. Test
/list_subscriptions product_name:sample-product catalog:test
- Auflistung der Abonnements nach API-Namen unter Verwendung eines bestimmten Plans für einen bestimmten Katalog
/list_subscriptions consumer_app:test-app consumer_org:test-org catalog:test
|