APIs veröffentlichen

UI

So rufen Sie den API-Katalog auf:

1. Wählen Sie Veröffentlichen > Portale und anschließend dein Portal aus.
2. Klicken Sie auf der Startseite des Portals auf API-Katalog. Alternativ können Sie im Drop-down-Menü des Portals in der oberen Navigationsleiste die Option API-Katalog auswählen.

Auf dem Tab APIs im API-Katalog wird eine Liste der APIs angezeigt, die Ihrem Portal hinzugefügt wurden.

Wie bereits erwähnt, können Sie auf dem Tab „APIs“ Folgendes tun:

• Details der auf Ihrem Portal verfügbaren APIs ansehen
• API zum Portal hinzufügen
• Eine API auf Ihrem Portal bearbeiten, indem Sie eine oder mehrere der folgenden Aufgaben ausführen:
  • Snapshot eines Dokuments verwalten, das mit einem API-Produkt verknüpft ist, um die API-Referenzdokumentation zu aktualisieren
  • APIs auf Ihrem Portal veröffentlichen oder ihre Veröffentlichung aufheben
  • Sichtbarkeit einer API in Ihrem Portal verwalten:
  • Callback-URL für eine API verwalten
  • Bild für eine API-Karte verwalten
  • API mithilfe von Kategorien taggen
  • Titel und Beschreibung der API bearbeiten
• API aus dem Portal entfernen
• Kategorien für die Suche nach zugehörigen APIs verwalten
• Schnell erkennen, welche Spezifikationen veraltet sind oder aus dem Spezifikationsspeicher gelöscht wurden
• Verwaiste APIs finden, deren zugehöriges API-Produkt aus Apigee Edge entfernt wurde, und Neuerstellung des API-Produkts bzw. Löschen der API aus dem Portal

curl

So listen Sie APIs auf:

curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs" \
    -H "Authorization: Bearer ACCESS_TOKEN"

Ersetzen Sie Folgendes:

• ORG_NAME durch den Namen der Organisation. Beispiel: my-org.
• SITE_ID durch den Namen des Portals im Format ORG_NAME-PORTAL_NAME, wobei ORG_NAME der Name der Organisation und PORTAL_NAME der Portalname ist, konvertiert in nur Kleinbuchstaben und ohne Leerzeichen und Bindestriche. Beispiel: my-org-myportal.
• ACCESS_TOKEN mit dem Authentifizierungstoken, das für den Zugriff auf die Apigee Edge API verwendet wird. Weitere Informationen zur Authentifizierung und zu Tokens finden Sie unter Zugriff auf die Edge API authentifizieren.

Unter Paginierungshinweise finden Sie eine Anleitung zur Verwendung der Paginierung in der Antwortnutzlast.

Antwortnutzlast:

{
  "status": "success",
  "message": "one page of apidocs returned",
  "data": [
    {
      "id": 622759,
      "siteId": "my-org-myportal",
      "title": "Test",
      "description": "",
      "published": false,
      "visibility": false,
      "apiId": "apiproducttest18",
      "apiProductName": "apiproduct_test18",
      "edgeAPIProductName": "apiproduct_test18",
      "specId": null,
      "specContent": null,
      "specTitle": null,
      "snapshotExists": false,
      "snapshotModified": null,
      "modified": 1724144471000,
      "anonAllowed": false,
      "imageUrl": null,
      "snapshotState": null,
      "requireCallbackUrl": false,
      "categoryIds": [],
      "specFormat": null,
      "specModified": null,
      "snapshotOutdated": false,
      "snapshotSourceMissing": false,
      "graphqlSchema": null,
      "graphqlEndpointUrl": null,
      "graphqlSchemaDisplayName": null,
      "grpcFileName": null,
      "grpcZipContent": null
    }
  ],
  "code": null,
  "request_id": "1452867334",
  "error_code": null,
  "next_page_token": ""
}

Wobei:

• modified: Zeit, zu der das Katalogelement zuletzt in Millisekunden seit der Epoche geändert wurde. Beispiel: 1698165480000.
• id: Die ID des Katalogelements. Beispiel: 399668.

Paginierungshinweise:

• Seitengröße: Mit pageSize geben Sie die Anzahl der Listenelemente an, die auf einer Seite zurückgegeben werden sollen. Der Standardwert ist 25 und der Höchstwert 100. Wenn weitere Seiten vorhanden sind, wird nextPageToken mit einem Token gefüllt:

  curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs?pageSize=PAGE_SIZE" \
     -H "Authorization: Bearer ACCESS_TOKEN"
  

  Ersetzen Sie:

  • PAGE_SIZE durch die Anzahl der Listenelemente, die auf einer Seite zurückgegeben werden sollen. Beispiel: 10.

  Antwortnutzlast:

  {
    "status": "success",
    "message": "one page of apidocs returned",
    "data": [
      {
        "id": 638007,
        "siteId": "tsnow-mint-liztest",
        "title": "Testing",
        "description": "",
        "published": false,
        "visibility": false,
        "apiId": "testcatalog",
        "apiProductName": "testcatalog",
        "edgeAPIProductName": "testcatalog",
        "specId": "Petstore",
        "specContent": null,
        "specTitle": null,
        "snapshotExists": true,
        "snapshotModified": 1726508367000,
        "modified": 1728582504000,
        "anonAllowed": false,
        "imageUrl": null,
        "snapshotState": "OK_SUBMITTED",
        "requireCallbackUrl": false,
        "categoryIds": [],
        "specFormat": "YAML",
        "specModified": null,
        "snapshotOutdated": false,
        "snapshotSourceMissing": false,
        "graphqlSchema": null,
        "graphqlEndpointUrl": null,
        "graphqlSchemaDisplayName": null,
        "grpcFileName": null,
        "grpcZipContent": null
      }
    ],
    "code": null,
    "request_id": "1068810934",
    "error_code": null,
    "next_page_token": ""
  }
  

• Seitentoken: Verwenden Sie pageToken, um nachfolgende Seiten abzurufen, wenn mehrere vorhanden sind:

  curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs?pageSize=PAGE_SIZE&pageToken=PAGE_TOKEN" \
        -H "Authorization: Bearer ACCESS_TOKEN"
  

  Ersetzen Sie:

  • PAGE_SIZE durch die Anzahl der Listenelemente, die auf einer Seite zurückgegeben werden sollen. Beispiel: 10.
  • PAGE_TOKEN durch den Wert nextPageToken. Beispiel: 7zcqrin9l6xhi4nbrb9

UI

So fügen Sie Ihrem Portal eine API hinzu:

1. Rufen Sie den API-Katalog auf.
2. Klicken Sie auf den Tab APIs, falls er nicht bereits ausgewählt ist.

3. Klicken Sie auf + Hinzufügen.

   Das Dialogfeld API-Produkt zum Katalog hinzufügen wird angezeigt.

4. Wählen Sie das API-Produkt aus, das Sie dem Portal hinzufügen möchten.

5. Klicken Sie auf Weiter. Die Seite API-Details wird angezeigt.

6. Konfigurieren Sie den Inhalt der API-Referenzdokumentation und ihre Sichtbarkeit im Portal:

   Feld	Beschreibung
   Veröffentlicht	Wählen Sie Veröffentlicht aus, um die API in Ihrem Portal zu veröffentlichen. Entfernen Sie das Häkchen aus dem Kästchen, wenn Sie die API nicht veröffentlichen möchten. Sie können die Einstellung später ändern, wie unter APIs auf Ihrem Portal veröffentlichen oder ihre Veröffentlichung aufheben beschrieben.
   Anzeigename	Aktualisieren Sie den Titel Ihrer API, der im Katalog angezeigt wird. Standardmäßig wird der API-Produktname verwendet. Sie können den Titel später ändern. Weitere Informationen dazu finden Sie unter Angezeigten Titel und Beschreibung bearbeiten.
   Angezeigte Beschreibung	Aktualisieren Sie die im Katalog angezeigte Beschreibung der API. Standardmäßig wird die API-Produktbeschreibung verwendet. Sie können die Anzeigebeschreibung später ändern, wie unter Angezeigten Titel und Beschreibung bearbeiten beschrieben.
   Entwickler müssen eine Callback-URL angeben	Aktivieren Sie diese Option, wenn App-Entwickler eine Callback-URL angeben sollen. Sie können die Callback-URL später hinzufügen oder aktualisieren, wie in Callback-URL für eine API verwalten beschrieben.
   API-Dokumentation	So verwenden Sie ein OpenAPI-Dokument: Wählen Sie OpenAPI-Dokument aus. Klicken Sie auf Dokument auswählen. Führen Sie einen der folgenden Schritte aus: Klicken Sie auf den Tab Meine Spezifikationen und wählen Sie eine Spezifikation aus dem Spec Store aus. Klicken Sie auf den Tab Datei hochladen und laden Sie eine Datei hoch. Klicken Sie auf den Tab Von einer URL importieren und importieren Sie eine Spezifikation aus einer URL. Klicken Sie auf Auswählen. So verwenden Sie ein GraphQL-Schema: Wählen Sie GraphQL-Schema. Klicken Sie auf Dokument auswählen. Rufen Sie das GraphQL-Schema auf und wählen Sie es aus. Klicken Sie auf Auswählen. Alternativ können Sie Keine Dokumentation auswählen und später eine anfügen, nachdem die API hinzugefügt wurde, wie unter Snapshot eines Dokuments verwalten beschrieben.
   API-Sichtbarkeit	Wenn Sie sich noch nicht für die Betaversion des Features zur Zielgruppenverwaltung angemeldet haben, wählen Sie eine der folgenden Optionen aus: Anonyme Nutzer, damit alle Nutzer die API sehen können. Registrierte Nutzer, um nur registrierten Nutzern Zugriff auf die API zu gewähren. Wenn Sie sich für die Betaversion der Funktion „Zielgruppenverwaltung“ angemeldet haben, wählen Sie eine der folgenden Optionen aus: Öffentlich (für alle sichtbar), damit alle Nutzer die API aufrufen können. Authentifizierte Nutzer, um nur authentifiziertem Nutzern Zugriff auf die API zu gewähren. Ausgewählte Zielgruppen, um die spezifischen Zielgruppen auszuwählen, die in der Lage sein sollen, die API aufzurufen. Sie können die Sichtbarkeit der Zielgruppe später verwalten, wie unter Sichtbarkeit einer API in Ihrem Portal verwalten beschrieben.
   Anzeigebild	Wenn auf der Seite „APIs“ ein Bild auf der API-Karte angezeigt werden soll, klicken Sie auf Bild auswählen. Wählen Sie im Dialogfeld Bild auswählen ein vorhandenes Bild aus, laden Sie ein neues Bild hoch oder geben Sie die URL eines externen Bilds an und klicken Sie auf Auswählen. Sehen Sie sich eine Vorschau der API-Miniaturansicht an und klicken Sie auf Auswählen. Sie können später ein Bild hinzufügen, wie unter Bild für eine API-Karte verwalten beschrieben. Wenn Sie ein Bild mit einer externen URL angeben, wird das Bild nicht in Ihre Assets hochgeladen. Außerdem hängt das Laden des Bildes im integrierten Portal von dessen Verfügbarkeit ab. Diese kann durch Inhaltssicherheitsrichtlinien blockiert oder eingeschränkt werden.
   Kategorien	Fügen Sie die Kategorien hinzu, für die die API getaggt wird, damit App-Entwickler auf der Seite „APIs“ ähnliche APIs finden können. So bestimmen Sie eine Kategorie: Wählen Sie eine Kategorie aus der Drop-down-Liste aus. Fügen Sie eine neue Kategorie hinzu, indem Sie ihre Bezeichnung eingeben und die Eingabetaste drücken. Die neue Kategorie wird der Seite „Kategorien“ hinzugefügt und bereitgestellt, sobald Sie weitere APIs hinzufügen oder bearbeiten.

7. Klicken Sie auf Speichern.

curl

So fügen Sie Ihrem Portal eine API hinzu :

curl -X POST "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
       "title": "TITLE",
       "description": "DESCRIPTION",
       "anonAllowed": ANON_TRUE_OR_FALSE,
       "imageUrl": "IMAGE_URL",
       "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
       "categoryIds": [
         "CATEGORY_ID1",
         "CATEGORY_ID2"
       ],
       "published": PUBLISHED_TRUE_OR_FALSE,
        "apiProductName": "API_PRODUCT"
    }'

Ersetzen Sie Folgendes:

• ORG_NAME durch den Namen der Organisation. Beispiel: my-org.
• SITE_ID durch den Namen des Portals im Format ORG_NAME-PORTAL_NAME, wobei ORG_NAME der Name der Organisation und PORTAL_NAME der Portalname ist, konvertiert in nur Kleinbuchstaben und ohne Leerzeichen und Bindestriche. Beispiel: my-org-myportal.
• ACCESS_TOKEN mit dem Authentifizierungstoken, das für den Zugriff auf die Apigee Edge API verwendet wird. Weitere Informationen zur Authentifizierung und zu Tokens finden Sie unter Zugriff auf die Edge API authentifizieren.
• TITLE durch den Anzeigetitel. Beispiel: Hello World 2.
• DESCRIPTION durch die angezeigte Beschreibung. Beispiel: Simple hello world example
• ANON_TRUE_OR_FALSE durch true oder false (Standard), wobei true bedeutet, dass diese API öffentlich sichtbar ist und anonym aufgerufen werden kann. Andernfalls können nur registrierte Nutzer darauf zugreifen.
• IMAGE_URL durch die URL eines externen Bildes, das für das Katalogelement verwendet wird, oder einen Dateipfad für im Portal gespeicherte Bilddateien, z. B. /files/book-tree.jpg. Wenn Sie die URL eines externen Bilds angeben, wird das Bild nicht in Ihre Assets hochgeladen. Außerdem hängt das Laden des Bildes im integrierten Portal von dessen Verfügbarkeit ab. Diese kann durch Inhaltssicherheitsrichtlinien blockiert oder eingeschränkt werden.
• CALLBACK_TRUE_OR_FALSE durch true oder false (Standard), wobei true erfordert, dass ein Portalnutzer beim Verwalten der Anwendung eine URL eingibt.
• CATEGORY_ID durch die ID der Kategorie. Beispiel: bf6505eb-2a0f-47af-a00a-ded40ac72960. Trennen Sie mehrere Kategorie-IDs durch ein Komma. Die Kategorie-ID erhalten Sie mit dem Befehl API-Listen auflisten.
• PUBLISHED_TRUE_OR_FALSE durch true oder false (Standard), wobei true angibt, dass die API öffentlich verfügbar ist. Nach der Veröffentlichung können Sie den Zugriff für alle Nutzer, authentifizierte Nutzer oder bestimmte Nutzer zulassen.
• API_PRODUCT durch den Namen des API-Produkts. Beispiel: Hello World 2.

Antwortnutzlast:

{
  "status": "success",
  "message": "API created",
  "data": {
    "id": 662423,
    "siteId": "my-org-myportal",
    "title": "My Test Catalog 4",
    "description": "",
    "published": false,
    "visibility": false,
    "apiId": "uxb9wjua",
    "apiProductName": "uXB9wJUa",
    "edgeAPIProductName": "uXB9wJUa",
    "specId": null,
    "specContent": null,
    "specTitle": null,
    "snapshotExists": false,
    "snapshotModified": null,
    "modified": 1729635493000,
    "anonAllowed": false,
    "imageUrl": null,
    "snapshotState": null,
    "requireCallbackUrl": false,
    "categoryIds": [],
    "specFormat": null,
    "specModified": null,
    "snapshotOutdated": null,
    "snapshotSourceMissing": false,
    "graphqlSchema": null,
    "graphqlEndpointUrl": null,
    "graphqlSchemaDisplayName": null,
    "grpcFileName": null,
    "grpcZipContent": null
  },
  "code": null,
  "request_id": "893346193",
  "error_code": null
}

Wobei:

• modified: Zeit, zu der das Katalogelement zuletzt in Millisekunden seit der Epoche geändert wurde. Beispiel: 1698165480000.
• id: Die ID des Katalogelements. Beispiel: 399668.

UI

So bearbeiten Sie eine API:

1. Rufen Sie den API-Katalog auf.
2. Klicken Sie auf den Tab APIs, falls er nicht bereits ausgewählt ist.
3. Klicken Sie auf die Zeile der API, die Sie bearbeiten möchten.
4. Klicken Sie auf Bearbeiten.
5. Nehmen Sie unter API-Details die gewünschten Änderungen vor. Eine Beschreibung der Optionen finden Sie unter API hinzufügen.
6. Klicken Sie auf Speichern.

curl

Nachdem Sie eine API hinzugefügt haben, können Sie mit dem Aufruf update Änderungen vornehmen.

In diesem Beispiel werden die Schritte beschrieben, mit denen Sie den veröffentlichten Status Ihrer API in Ihrem Portal von true zu false ändern können. Bei Bedarf können Sie mehrere Einstellungen in einem API-Aufruf ändern.

1. Rufen Sie wie unter APIs ansehen beschrieben eine Liste der APIs in Ihrem Portal ab, um die generierte id zu finden, die jede API eindeutig identifiziert.

2. Aktuelle Werte für eine bestimmte API zurückgeben:

   curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
   -H "Authorization: Bearer ACCESS_TOKEN"
   

   Ersetzen Sie Folgendes:

   • ORG_NAME durch den Namen der Organisation. Beispiel: my-org.
   • SITE_ID durch den Namen des Portals im Format ORG_NAME-PORTAL_NAME, wobei ORG_NAME der Name der Organisation und PORTAL_NAME der Portalname ist, konvertiert in nur Kleinbuchstaben und ohne Leerzeichen und Bindestriche. Beispiel: my-org-myportal.
   • API_DOC durch die generierte id des Dokuments. Beispiel: 399668. Verwenden Sie den Befehl list API docs, um diesen Wert zu finden.
   • ACCESS_TOKEN mit dem Authentifizierungstoken, das für den Zugriff auf die Apigee Edge API verwendet wird. Weitere Informationen zur Authentifizierung und zu Tokens finden Sie unter Zugriff auf die Edge API authentifizieren.

   Antwortnutzlast:

   {
     "status": "success",
     "message": "apidoc returned",
     "data": {
       "id": 662423,
       "siteId": "my-org-myportal",
       "title": "My Test Catalog 4",
       "description": "",
       "published": false,
       "visibility": false,
       "apiId": "uxb9wjua",
       "apiProductName": "uXB9wJUa",
       "edgeAPIProductName": "uXB9wJUa",
       "specId": null,
       "specContent": null,
       "specTitle": null,
       "snapshotExists": false,
       "snapshotModified": null,
       "modified": 1729635493000,
       "anonAllowed": false,
       "imageUrl": null,
       "snapshotState": null,
       "requireCallbackUrl": false,
       "categoryIds": [],
       "specFormat": null,
       "specModified": null,
       "snapshotOutdated": false,
       "snapshotSourceMissing": false,
       "graphqlSchema": null,
       "graphqlEndpointUrl": null,
       "graphqlSchemaDisplayName": null,
       "grpcFileName": null,
       "grpcZipContent": null
     },
     "code": null,
     "request_id": "601210268",
     "error_code": null
   }
   

1. Fügen Sie die änderbaren Werte, die Sie in den update-Aufruf aufnehmen möchten, ein und ändern Sie die gewünschten Werte. Wenn Sie eine Zeile weglassen, wird die Standardeinstellung verwendet. Ändern Sie in diesem Beispiel die Einstellung „Veröffentlicht“ von false in true:

   curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
       "title": "TITLE",
       "anonAllowed": true,
       "published": true
    }'
   

   Ersetzen Sie Folgendes:

   • TITLE durch den Anzeigetitel. Beispiel: Hello World 2.

   Antwortnutzlast:

   {
     "status": "success",
     "message": "ApiDoc updated",
     "data": {
       "id": 662423,
       "siteId": "my-org-myportal",
       "title": "My Test Catalog 4",
       "description": "",
       "published": true,
       "visibility": true,
       "apiId": "uxb9wjua",
       "apiProductName": "uXB9wJUa",
       "edgeAPIProductName": "uXB9wJUa",
       "specId": null,
       "specContent": null,
       "specTitle": null,
       "snapshotExists": false,
       "snapshotModified": null,
       "modified": 1729989250000,
       "anonAllowed": true,
       "imageUrl": null,
       "snapshotState": null,
       "requireCallbackUrl": false,
       "categoryIds": [],
       "specFormat": null,
       "specModified": null,
       "snapshotOutdated": null,
       "snapshotSourceMissing": false,
       "graphqlSchema": null,
       "graphqlEndpointUrl": null,
       "graphqlSchemaDisplayName": null,
       "grpcFileName": null,
       "grpcZipContent": null
     },
     "code": null,
     "request_id": "738172002",
     "error_code": null
   }
   

UI

So veröffentlichen Sie eine API auf Ihrem Portal oder heben die Veröffentlichung auf:

1. Rufen Sie den API-Katalog auf.
2. Klicken Sie auf den Tab APIs, falls er nicht bereits ausgewählt ist.
3. Klicken Sie auf die Zeile der API, die Sie bearbeiten möchten.
4. Klicken Sie auf  Bearbeiten.
5. Wählen Sie unter API-Details die Option Veröffentlicht (im Katalog aufgeführt) aus oder heben Sie die Auswahl auf, um die API auf Ihrem Portal zu veröffentlichen bzw. ihre Veröffentlichung rückgängig zu machen.
6. Klicken Sie auf Speichern.

curl

Fügen Sie einen der folgenden Parameter in den Updateaufruf ein:

"published": true,    # API is published to your portal
"published": false,   # API is not published in your portal

So bearbeiten Sie die API:

1. Aktuelle Werte zurückgeben:

   curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs" \
   -H "Authorization: Bearer ACCESS_TOKEN"

2. Verwenden Sie den update-Aufruf, um die API zu bearbeiten. Fügen Sie die änderbaren Werte, die Sie beibehalten möchten, ein und ändern Sie die gewünschten Werte. Wenn Sie eine veränderbare Einstellung weglassen, wird sie mit dem Standardwert überschrieben.

   curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/  ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
       "title": "TITLE",
       "description": "DESCRIPTION",
       "anonAllowed": ANON_TRUE_OR_FALSE,
       "imageUrl": IMAGE_URL,
       "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
       "categoryIds": [
         "CATEGORY_ID1",
        "CATEGORY_ID2"
       ],
       "published": PUBLISHED_TRUE_OR_FALSE
   }

Ein ausführliches Beispiel für die Schritte, Variablen und Nutzlast, die zurückgegeben werden, finden Sie unter Version des Dokuments verwalten.

UI

So verwalten Sie die Sichtbarkeit einer API in Ihrem Portal:

1. Rufen Sie den API-Katalog auf.
2. Klicken Sie auf den Tab APIs, falls er nicht bereits ausgewählt ist.
3. Klicken Sie auf die Zeile der API, die Sie bearbeiten möchten.
4. Klicken Sie auf  Bearbeiten.

5. Wählen Sie die Sichtbarkeitseinstellung aus. Wenn Sie sich für die Betaversion der Zielgruppenfunktion angemeldet haben, wählen Sie eine der folgenden Optionen aus:

   • Öffentlich (für alle sichtbar), damit alle Nutzer die Seite aufrufen können.
   • Authentifizierte Nutzer, um nur registrierten Nutzern die Anzeige der Seite zu ermöglichen.
   • Ausgewählte Zielgruppen, damit nur von Ihnen festgelegte Zielgruppen die Seite aufrufen können. Weitere Informationen finden Sie unter Zielgruppen für Ihr Portal verwalten.
   Wählen Sie andernfalls eine der folgenden Optionen aus:
   • Anonyme Nutzer, um allen Nutzern die Anzeige der Seite zu ermöglichen.
   • Registrierte Nutzer, um nur registrierten Nutzern die Anzeige der Seite zu ermöglichen.

6. Klicken Sie auf Senden.

curl

Wenn Sie sich für die Betaversion der Funktion zur Zielgruppenverwaltung angemeldet haben, können Sie die Zielgruppen über die Benutzeroberfläche verwalten.

Wenn Sie sich nicht für die Funktion zur Zielgruppenverwaltung registriert haben, wird die Sichtbarkeit über anonAllowed verwaltet.

Fügen Sie einen der folgenden Parameter in den update-Aufruf ein:

  # When not enrolled in the beta release of the audience management feature:

  "anonAllowed": true,      # Anonymous users can see the API
  "anonAllowed": false,     # Only registered users can see the API

So bearbeiten Sie die API:

1. Aktuelle Werte zurückgeben:

   curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN"
   

2. Verwenden Sie den update-Aufruf, um die API zu bearbeiten. Fügen Sie die änderbaren Werte, die Sie beibehalten möchten, ein und ändern Sie die gewünschten Werte. Wenn Sie eine veränderbare Einstellung weglassen, wird der Standardwert verwendet.

   curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN" \
        -H "Content-Type: application/json" \
        -d '{
           "title": "TITLE",
           "description": "DESCRIPTION",
           "anonAllowed": ANON_TRUE_OR_FALSE,
           "imageUrl": IMAGE_URL,
           "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
           "categoryIds": [
             "CATEGORY_ID1",
             "CATEGORY_ID2"
           ],
           "published": PUBLISHED_TRUE_OR_FALSE
        }'

Ein detailliertes Beispiel für die Schritte, Variablen und zurückgegebene Nutzlast finden Sie unter API bearbeiten.

UI

So verwalten Sie die Callback-URL für eine API:

1. Rufen Sie den API-Katalog auf.
2. Klicken Sie auf den Tab APIs, falls er nicht bereits ausgewählt ist.
3. Klicken Sie auf die Zeile der API, die Sie bearbeiten möchten.
4. Klicken Sie auf  Bearbeiten.
5. Aktivieren oder deaktivieren Sie unter API-Details das Kästchen Entwickler müssen eine Callback-URL angeben.
6. Klicken Sie auf Speichern.

curl

Fügen Sie einen der folgenden Parameter in den update-Aufruf ein:

  "requireCallbackUrl": true,    # Portal user is required to input a URL
  "requireCallbackUrl": false,   # Portal user is not required to input a URL

So bearbeiten Sie die API:

1. Aktuelle Werte zurückgeben:

   curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN"
   

2. Verwenden Sie den update-Aufruf, um die API zu bearbeiten. Fügen Sie die änderbaren Werte, die Sie beibehalten möchten, ein und ändern Sie die gewünschten Werte. Wenn Sie eine veränderbare Einstellung weglassen, wird der Standardwert verwendet.

   curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN" \
        -H "Content-Type: application/json" \
        -d '{
           "title": "TITLE",
           "description": "DESCRIPTION",
           "anonAllowed": ANON_TRUE_OR_FALSE,
           "imageUrl": IMAGE_URL,
           "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
           "categoryIds": [
             "CATEGORY_ID1",
             "CATEGORY_ID2"
           ],
           "published": PUBLISHED_TRUE_OR_FALSE
        }'

Ein detailliertes Beispiel für die Schritte, Variablen und zurückgegebene Nutzlast finden Sie unter API bearbeiten.

UI

So verwalten Sie das Bild für eine API-Karte:

1. Rufen Sie den API-Katalog auf.
2. Klicken Sie auf den Tab APIs, falls er nicht bereits ausgewählt ist.
3. Klicken Sie auf die Zeile der API, die Sie bearbeiten möchten.
4. Klicken Sie auf  Bearbeiten.

5. Gehen Sie unter API-Details folgendermaßen vor:

   • Klicken Sie auf Bild auswählen, um ein Bild anzugeben oder hochzuladen, falls derzeit keins ausgewählt ist.
   • Klicken Sie auf Bild ändern, um ein anderes Bild anzugeben oder hochzuladen.
   • Klicken Sie im Bild auf x, um es zu entfernen.

   Geben Sie beim Angeben eines Bildes entweder ein Bild mit einer externen URL an, die für das Katalogelement verwendet wird, oder einen Pfad für im Portal gespeicherte Bilddateien. Beispiel: /files/book-tree.jpg. Wenn Sie die URL eines externen Bilds angeben, wird das Bild nicht in Ihre Assets hochgeladen. Darüber hinaus hängt das Laden des Bildes im integrierten Portal von dessen Verfügbarkeit ab. Diese kann durch Inhaltssicherheitsrichtlinien blockiert oder eingeschränkt werden.

6. Klicken Sie auf Speichern.

curl

Fügen Sie Folgendes in den update-Aufruf ein:

  # Omit line for no image file

  "imageUrl": "IMAGE_URL"    # URL of the external image or name of the image file

So bearbeiten Sie die API:

1. Aktuelle Werte zurückgeben:

   curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN"
   

2. Verwenden Sie den update-Aufruf, um die API zu bearbeiten. Fügen Sie die änderbaren Werte, die Sie beibehalten möchten, ein und ändern Sie die gewünschten Werte. Wenn Sie eine veränderbare Einstellung weglassen, wird der Standardwert verwendet.

   curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN" \
        -H "Content-Type: application/json" \
        -d '{
           "title": "TITLE",
           "description": "DESCRIPTION",
           "anonAllowed": ANON_TRUE_OR_FALSE,
           "imageUrl": IMAGE_URL,
           "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
           "categoryIds": [
             "CATEGORY_ID1",
             "CATEGORY_ID2"
           ],
           "published": PUBLISHED_TRUE_OR_FALSE
        }'

Ein detailliertes Beispiel für die Schritte, Variablen und zurückgegebene Nutzlast finden Sie unter API bearbeiten.

UI

So versehen Sie eine API mit Kategorien, wenn Sie die API bearbeiten:

1. Rufen Sie den API-Katalog auf.
2. Klicken Sie auf den Tab APIs, falls er nicht bereits ausgewählt ist.
3. Klicken Sie auf die Zeile der API, die Sie bearbeiten möchten.
4. Klicken Sie auf  Bearbeiten.
5. Klicken Sie auf das Feld Kategorien und führen Sie einen der folgenden Schritte aus:
   • Wählen Sie eine Kategorie aus der Drop-down-Liste aus.
   • Fügen Sie eine neue Kategorie hinzu, indem Sie ihre Bezeichnung eingeben und die Eingabetaste drücken. Die neue Kategorie wird der Seite „Kategorien“ hinzugefügt und bereitgestellt, sobald Sie weitere APIs hinzufügen oder bearbeiten.
6. Wiederholen Sie diese Schritte, um die API mehreren Kategorien zuzuordnen.
7. Klicken Sie auf Speichern.

curl

Fügen Sie Folgendes in den update-Aufruf ein:

  # Omit line for no categories

  "categoryIds": [
      "CATEGORY_ID1",      # A category ID number
      "CATEGORY_ID2"       # A category ID number
    ],

Verwenden Sie den Befehl list categories, um die Kategorien-ID-Nummern abzurufen.

So bearbeiten Sie die API:

1. Aktuelle Werte zurückgeben:

   curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN"
   

2. Verwenden Sie den update-Aufruf, um die API zu bearbeiten. Fügen Sie die änderbaren Werte, die Sie beibehalten möchten, ein und ändern Sie die gewünschten Werte. Wenn Sie eine veränderbare Einstellung weglassen, wird der Standardwert verwendet.

   curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN" \
        -H "Content-Type: application/json" \
        -d '{
           "title": "TITLE",
           "description": "DESCRIPTION",
           "anonAllowed": ANON_TRUE_OR_FALSE,
           "imageUrl": IMAGE_URL,
           "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
           "categoryIds": [
             "CATEGORY_ID1",
             "CATEGORY_ID2"
           ],
           "published": PUBLISHED_TRUE_OR_FALSE
        }'

Ein detailliertes Beispiel für die Schritte, Variablen und zurückgegebene Nutzlast finden Sie unter API bearbeiten.

UI

So bearbeiten Sie den angezeigten Titel und die Beschreibung:

1. Rufen Sie den API-Katalog auf.
2. Klicken Sie auf den Tab APIs, falls er nicht bereits ausgewählt ist.
3. Klicken Sie auf die Zeile der API, die Sie bearbeiten möchten.
4. Klicken Sie auf  Bearbeiten.
5. Bearbeiten Sie nach Bedarf die Felder Titel anzeigen und Beschreibung anzeigen.
6. Klicken Sie auf Speichern.

curl

Fügen Sie Folgendes in den update-Aufruf ein:

  "title": "TITLE",    # Display title
  "description": "DESCRIPTION",  # Display description

So bearbeiten Sie die API:

1. Aktuelle Werte zurückgeben:

   curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN"
   

2. Verwenden Sie den update-Aufruf, um die API zu bearbeiten. Fügen Sie die änderbaren Werte, die Sie beibehalten möchten, ein und ändern Sie die gewünschten Werte. Wenn Sie eine veränderbare Einstellung weglassen, wird der Standardwert verwendet.

   curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN" \
        -H "Content-Type: application/json" \
        -d '{
           "title": "TITLE",
           "description": "DESCRIPTION",
           "anonAllowed": ANON_TRUE_OR_FALSE,
           "imageUrl": IMAGE_URL,
           "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
           "categoryIds": [
             "CATEGORY_ID1",
             "CATEGORY_ID2"
           ],
           "published": PUBLISHED_TRUE_OR_FALSE
        }'

Ein detailliertes Beispiel für die Schritte, Variablen und zurückgegebene Nutzlast finden Sie unter API bearbeiten.

UI

So entfernen Sie eine API aus dem Portal:

1. Rufen Sie den API-Katalog auf.
2. Wählen Sie die APIs aus, falls Sie diese nicht bereits ausgewählt haben.
3. Bewegen Sie den Mauszeiger in der Liste auf die API, um das Aktionsmenü einzublenden.
4. Klicken Sie auf Löschen.

curl

So entfernen Sie eine API aus Ihrem Portal:

curl -X DELETE "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
    -H "Authorization: Bearer ACCESS_TOKEN"

Ersetzen Sie Folgendes:

• ORG_NAME durch den Namen der Organisation. Beispiel: my-org.
• SITE_ID durch den Namen des Portals im Format ORG_NAME-PORTAL_NAME, wobei ORG_NAME der Name der Organisation und PORTAL_NAME der Portalname ist, konvertiert in nur Kleinbuchstaben und ohne Leerzeichen und Bindestriche. Beispiel: my-org-myportal.
• API_DOC durch die generierte id des Dokuments. Beispiel: 399668. Verwenden Sie den Befehl list API docs, um diesen Wert zu finden.
• ACCESS_TOKEN mit dem Authentifizierungstoken, das für den Zugriff auf die Apigee Edge API verwendet wird. Weitere Informationen zur Authentifizierung und zu Tokens finden Sie unter Zugriff auf die Edge API authentifizieren.

Antwortnutzlast:

{
  "status": "success",
  "message": "Apidoc deleted",
  "data": {
  },
  "code": null,
  "request_id": "1790036484",
  "error_code": null
}

UI

1. Rufen Sie den API-Katalog auf.
2. Klicken Sie auf den Tab APIs, falls er nicht bereits ausgewählt ist.
3. Klicken Sie auf die Zeile der API, die Sie bearbeiten möchten.
4. Prüfen Sie den Snapshot-Status. Wenn er nicht mehr aktuell ist, wird die folgende Meldung angezeigt:
5. Klicken Sie auf edit Bearbeiten.
6. Führen Sie eine der folgenden Aufgaben aus:
   • Wenn Sie einen veralteten Snapshot eines OpenAPI-Dokuments aktualisieren möchten, klicken Sie auf Snapshot aktualisieren.
   • Wenn Sie das Dokument ändern möchten, mit dem die Dokumentation für die API generiert wird, klicken Sie unter „API-Dokumentation“ auf Dokument auswählen und wählen Sie das neue Dokument aus.
7. Wählen Sie im Bereich API-Dokumentation eine der folgenden Optionen aus:
   • OpenAPI-Dokument
   • GraphQL-Schema
8. Klicken Sie auf Dokument auswählen und wählen Sie die neueste Version des Dokuments aus.
9. Geben Sie für GraphQL die Endpunkt-URL an.
10. Klicken Sie auf Speichern.

Die API-Referenzdokumentation wird aus dem Dokument gerendert und der API-Referenzseite hinzugefügt. Der Snapshot-Status wird auf den neuesten Stand gebracht:

curl

So aktualisieren Sie den Inhalt der OpenAPI- oder GraphQL-Dokumentation:

curl -X PATCH "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC/documentation" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{"oasDocumentation": {
           "spec":{ "displayName":"DISPLAY_NAME",
                    "contents":"CONTENTS"}
            }
        }'

{
 "status":"success",
 "message":"Api documentation updated",
 "requestId":"645138278"
 "data": {
   "oasDocumentation": {
     "spec": {
        "displayName": "Hello World 2"
      },
     "Format": "YAML"
   }
 }
}

curl -X PATCH "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC/documentation" \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"graphqlDocumentation": {
         "schema":{"displayName":"DISPLAY_NAME",
         "contents":"CONTENTS"},
         "endpointUri": "ENDPOINT_URI"
          }
      }'

{
"status": "success",
"message": "ApiDocDocumentation updated",
"data": {
  "oasDocumentation": null,
  "graphqlDocumentation": {
    "schema": {
      "displayName": "schema.docs.graphql",
      "contents": ""
    },
    "endpointUri": "https://demo.google.com/graphql"
  }
},
"code": null,
"request_id": "640336173",
"error_code": null
}

UI

curl

So laden Sie die API-Dokumentation mit get documentation herunter:

curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC/documentation" \
    -H "Authorization: Bearer ACCESS_TOKEN"

Ersetzen Sie Folgendes:

• ORG_NAME durch den Namen der Organisation. Beispiel: my-org.
• SITE_ID durch den Namen des Portals im Format ORG_NAME-PORTAL_NAME, wobei ORG_NAME der Name der Organisation und PORTAL_NAME der Portalname ist, konvertiert in nur Kleinbuchstaben und ohne Leerzeichen und Bindestriche. Beispiel: my-org-myportal.

• API_DOC durch die generierte id des Dokuments. Beispiel: 399668. Verwenden Sie den Befehl list API docs, um diesen Wert zu finden.

  Antwortnutzlast:

{
  "status": "success",
  "message": "ApiDocDocumentation returned",
  "data": {
    "oasDocumentation": {
      "spec": {
        "displayName": "mock",
        "contents": "b3BlbmFwaTogMy4wLjAKaW5mbzoKICBkZXNjcmlw ..."
      },
      "format": "YAML"
    },
    "graphqlDocumentation": null
  },
  "code": null,
  "request_id": "269996898",
  "error_code": null
}

Wobei:

contents: Der base64-codierte String der Inhalte der API-Dokumentation.

UI

1. Rufen Sie den API-Katalog auf.
2. Klicken Sie auf den Tab APIs, falls er nicht bereits ausgewählt ist.
3. Klicken Sie auf die Zeile der API, die Sie bearbeiten möchten.
4. Klicken Sie auf edit Bearbeiten.
5. Wählen Sie im Bereich API-Dokumentation die Option Keine Dokumentation aus.
6. Klicken Sie auf Speichern.

curl

Verwende die Update API, um vorhandene Inhalte zu löschen:

curl -X PATCH "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC/documentation" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{}'

Ersetzen Sie Folgendes:

• ORG_NAME durch den Namen der Organisation. Beispiel: my-org.
• SITE_ID durch den Namen des Portals im Format ORG_NAME-PORTAL_NAME, wobei ORG_NAME der Name der Organisation und PORTAL_NAME der Portalname ist, konvertiert in nur Kleinbuchstaben und ohne Leerzeichen und Bindestriche. Beispiel: my-org-myportal.
• API_DOC durch die generierte id des Dokuments. Beispiel: 399668. Verwenden Sie den Befehl list API docs, um diesen Wert zu finden.

Antwortnutzlast:

{
  "status": "success",
  "message": "ApiDocDocumentation updated",
  "data": {
    "oasDocumentation": null,
    "graphqlDocumentation": null
  },
  "code": null,
  "request_id": "304329676",
  "error_code": null
}

UI

So rufen Sie die Seite „Kategorien“ auf:

1. Wählen Sie Veröffentlichen > Portale und anschließend das Portal aus.
2. Klicken Sie auf der Startseite des Portals auf API-Katalog.

   Alternativ können Sie im Drop-down-Menü des Portals in der oberen Navigationsleiste die Option API-Katalog auswählen.

3. Klicken Sie auf den Tab Kategorien.

Auf dem Tab Kategorien im API-Katalog wird die Liste der Kategorien angezeigt, die für Ihr Portal festgelegt wurden.

Wie bereits erwähnt, können Sie auf der Seite „APIs“ Folgendes tun:

• Kategorien und APIs ansehen, denen sie zugeordnet wurden
• Kategorie hinzufügen
• Kategorie bearbeiten
• Kategorie löschen
• In Ihrem Portal veröffentlichte APIs verwalten. API-Katalog ansehen

curl

So listen Sie Kategorien auf:

curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apicategories" \
    -H "Authorization: Bearer ACCESS_TOKEN"

Ersetzen Sie Folgendes:

• ORG_NAME durch den Namen der Organisation. Beispiel: my-org.
• SITE_ID durch den Namen des Portals im Format ORG_NAME-PORTAL_NAME, wobei ORG_NAME der Name der Organisation und PORTAL_NAME der Portalname ist, konvertiert in nur Kleinbuchstaben und ohne Leerzeichen und Bindestriche. Beispiel: my-org-myportal.
• ACCESS_TOKEN mit dem Authentifizierungstoken, das für den Zugriff auf die Apigee Edge API verwendet wird. Weitere Informationen zur Authentifizierung und zu Tokens finden Sie unter Zugriff auf die Edge API authentifizieren.

Antwortnutzlast:

{
  "status": "success",
  "message": "all ApiCategory items returned",
  "data": [
    {
      "id": "e0518597-ece2-4d7d-ba7c-d1793df0f8db",
      "siteId": "my-org-myportal",
      "name": "My Category"
    },
    {
      "id": "61c1014c-89c9-40e6-be3c-69cca3505620",
      "siteId": "my-org-myportal",
      "name": "test2"
    }
  ],
  "code": null,
  "request_id": "1263510680",
  "error_code": null
}

Wobei:

• id: Die ID des Kategorieeintrags. Beispiel: 61c1014c-89c9-40e6-be3c-69cca3505620

UI

So fügen Sie eine Kategorie manuell hinzu:

1. Rufen Sie die Seite „Kategorien“ auf.
2. Klicken Sie auf + Hinzufügen.
3. Geben Sie den Namen Ihrer neuen Kategorie ein.
4. Optional können Sie eine oder mehrere APIs auswählen, die mit der Kategorie versehen werden sollen.
5. Klicken Sie auf Erstellen.

curl

So fügen Sie eine Kategorie hinzu:

curl -X POST "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apicategories" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{"name": "CATEGORY_NAME" }'

Ersetzen Sie Folgendes:

• ORG_NAME durch den Namen der Organisation. Beispiel: my-org.
• SITE_ID durch den Namen des Portals im Format ORG_NAME-PORTAL_NAME, wobei ORG_NAME der Name der Organisation und PORTAL_NAME der Portalname ist, konvertiert in nur Kleinbuchstaben und ohne Leerzeichen und Bindestriche. Beispiel: my-org-myportal.
• ACCESS_TOKEN mit dem Authentifizierungstoken, das für den Zugriff auf die Apigee Edge API verwendet wird. Weitere Informationen zur Authentifizierung und zu Tokens finden Sie unter Zugriff auf die Edge API authentifizieren.
• CATEGORY_NAME durch den Namen der Kategorie. Beispiel: demo-backend

Antwortnutzlast:

{
  "status": "success",
  "message": "API category created",
  "data": {
    "id": "61de810e-b48b-4cc1-8f22-959038aadcce",
    "siteId": "my-org-myportal",
    "name": "demo-backend"
  },
  "code": null,
  "request_id": "363146927",
  "error_code": null
}

UI

So bearbeiten Sie eine Kategorie:

1. Rufen Sie die Seite „Kategorien“ auf.
2. Klicken Sie auf  Bearbeiten.
3. Bearbeiten Sie den Namen der Kategorie.
4. Fügen Sie API-Tags hinzu oder entfernen Sie sie.
5. Klicken Sie auf Speichern.

curl

So bearbeiten Sie eine Kategorie:

curl -X PATCH "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apicategories/CATEGORY_ID"  \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{"name": "CATEGORY_NAME" }'

Ersetzen Sie Folgendes:

• ORG_NAME durch den Namen der Organisation. Beispiel: my-org.
• SITE_ID durch den Namen des Portals im Format ORG_NAME-PORTAL_NAME, wobei ORG_NAME der Name der Organisation und PORTAL_NAME der Portalname ist, konvertiert in nur Kleinbuchstaben und ohne Leerzeichen und Bindestriche. Beispiel: my-org-myportal.
• CATEGORY_ID durch die ID der Kategorie. Beispiel: bf6505eb-2a0f-47af-a00a-ded40ac72960. Trennen Sie mehrere Kategorie-IDs durch ein Komma. Die Kategorie-ID erhalten Sie mit dem Befehl API-Listen auflisten.
• ACCESS_TOKEN mit dem Authentifizierungstoken, das für den Zugriff auf die Apigee Edge API verwendet wird. Weitere Informationen zur Authentifizierung und zu Tokens finden Sie unter Zugriff auf die Edge API authentifizieren.
• CATEGORY_NAME durch den Namen der Kategorie. Beispiel: demo-backend

Antwortnutzlast:

{
  "status": "success",
  "message": "ApiCategory updated",
  "data": {
    "id": "61de810e-b48b-4cc1-8f22-959038aadcce",
    "siteId": "my-org-myportal",
    "name": "demo-backend-test"
  },
  "code": null,
  "request_id": "1976875617",
  "error_code": null
}

UI

So löschen Sie eine Kategorie:

1. Rufen Sie die Seite „Kategorien“ auf.
2. Bewegen Sie den Mauszeiger auf die Kategorie, die Sie bearbeiten möchten, damit das Aktionsmenü eingeblendet wird.
3. Klicken Sie auf Löschen.
4. Klicken Sie zur Bestätigung auf Löschen.

curl

So löschen Sie eine Kategorie:

curl -X DELETE "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apicategories/CATEGORY_ID" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json"

Ersetzen Sie Folgendes:

• ORG_NAME durch den Namen der Organisation. Beispiel: my-org.
• SITE_ID durch den Namen des Portals im Format ORG_NAME-PORTAL_NAME, wobei ORG_NAME der Name der Organisation und PORTAL_NAME der Portalname ist, konvertiert in nur Kleinbuchstaben und ohne Leerzeichen und Bindestriche. Beispiel: my-org-myportal.
• CATEGORY_ID durch die ID der Kategorie. Beispiel: bf6505eb-2a0f-47af-a00a-ded40ac72960. Die Kategorie-ID erhalten Sie mit dem Befehl API-Listen auflisten.
• ACCESS_TOKEN mit dem Authentifizierungstoken, das für den Zugriff auf die Apigee Edge API verwendet wird. Weitere Informationen zur Authentifizierung und zu Tokens finden Sie unter Zugriff auf die Edge API authentifizieren.

Antwortnutzlast:

{
  "status": "success",
  "message": "ApiCategory deleted",
  "data": {
  },
  "code": null,
  "request_id": "2032819627",
  "error_code": null
}