Publikowanie interfejsów API

Interfejs użytkownika

Aby wyświetlić katalog interfejsu API:

1. Kliknij Opublikuj > Portale, a następnie wybierz swój portal.
2. Na stronie głównej portalu kliknij Katalog interfejsów API. Możesz też wybrać Katalog interfejsów API w menu portalu na górnym pasku nawigacyjnym.

Na karcie Interfejsy API w katalogu interfejsów API znajduje się lista interfejsów API dodanych do portalu.

Jak widać na poprzednim rysunku, na karcie Interfejsy API możesz:

• Wyświetlanie szczegółów interfejsów API dostępnych na Twoim portalu
• Dodawanie interfejsu API do portalu
• Aby edytować interfejs API w portalu, wykonaj co najmniej 1 z tych czynności:
  • Zarządzanie migawką dokumentu powiązanego z produktem interfejsu API w celu zaktualizowania dokumentacji referencyjnej interfejsu API
  • Publikowanie i wycofywanie interfejsu API w portalu
  • Zarządzanie widocznością interfejsu API w portalu:
  • Zarządzanie adresem URL wywołania zwrotnego interfejsu API
  • Zarządzanie obrazem na karcie interfejsu API
  • Tagowanie interfejsu API za pomocą kategorii
  • Edytowanie tytułu i opisu interfejsu API
• Usuwanie interfejsu API z portalu
• Zarządzanie kategoriami służącymi do znajdowania powiązanych interfejsów API
• Szybkie identyfikowanie specyfikacji, które są nieaktualne lub zostały usunięte ze sklepu ze specyfikacjami
• Szybko identyfikować osieroczone interfejsy API, których powiązana usługa API została usunięta z Apigee Edge, oraz ponownie tworzyć usługę API lub usuwać interfejs API z portalu.

curl

Aby wyświetlić listę interfejsów API:

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

Zastąp następujące elementy:

• ORG_NAME nazwą organizacji. Na przykład: my-org.
• SITE_ID z nazwą portalu w formacie ORG_NAME-PORTAL_NAME, gdzie ORG_NAME to nazwa organizacji, a PORTAL_NAME to nazwa portalu w postaci wyłącznie małych liter bez spacji i myślników. Na przykład: my-org-myportal.
• ACCESS_TOKEN z tokenem uwierzytelniania używanym do uzyskiwania dostępu do interfejsu Apigee Edge API. Więcej informacji o uwierzytelnianiu i tokenach znajdziesz w artykule Uwierzytelnianie dostępu do interfejsu Edge API.

Instrukcje dotyczące korzystania z podziału na strony w pliku odpowiedzi znajdziesz w sekcji Uwagi dotyczące podziału na strony.

Ładunek odpowiedzi:

{
  "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": ""
}

Gdzie:

• modified: czas ostatniej modyfikacji elementu w katalogu w milisekundach od początku epoki. Na przykład: 1698165480000.
• id: identyfikator produktu w katalogu. Na przykład: 399668.

Uwagi dotyczące strony:

• Rozmiar strony: użyj parametru pageSize, aby określić liczbę elementów listy, które mają zostać zwrócone na jednej stronie. Wartość domyślna to 25, a maksymalna – 100. Jeśli są dodatkowe strony, nextPageToken jest wypełniany za pomocą tokena:

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

  Zastąp:

  • PAGE_SIZE z liczbą elementów listy do zwrócenia na jednej stronie. Na przykład 10.

  Ładunek odpowiedzi:

  {
    "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": ""
  }
  

• Token strony: użyj parametru pageToken, aby pobrać kolejne strony, jeśli jest ich więcej niż 1:

  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"
  

  Zastąp:

  • PAGE_SIZE z liczbą elementów listy do zwrócenia na jednej stronie. Na przykład 10.
  • PAGE_TOKEN z wartością nextPageToken. Na przykład: 7zcqrin9l6xhi4nbrb9.

Interfejs użytkownika

Aby dodać interfejs API do portalu:

1. Uzyskaj dostęp do katalogu interfejsów API.
2. Kliknij kartę Interfejsy API, jeśli nie jest jeszcze wybrana.

3. Kliknij + Dodaj.

   Wyświetli się okno Dodaj produkt z interfejsem API do katalogu.

4. Wybierz usługę API, którą chcesz dodać do portalu.

5. Kliknij Dalej. Pojawi się strona Szczegóły interfejsu API.

6. Skonfiguruj zawartość dokumentacji na temat interfejsu API oraz jej widoczność w portalu:

   Pole	Opis
   Opublikowano	Aby opublikować interfejs API w portalu, wybierz Opublikowano. Jeśli nie chcesz jeszcze publikować interfejsu API, odznacz to pole. Możesz zmienić to ustawienie później, zgodnie z instrukcjami podanymi w artykule Publikowanie interfejsu API lub wycofywanie go z użycia w portalu.
   Wyświetl tytuł	Zaktualizuj tytuł interfejsu API wyświetlany w katalogu. Domyślnie używana jest nazwa usługi interfejsu API. Wyświetlany tytuł możesz zmienić później, zgodnie z instrukcjami podanymi w artykule Edytuj wyświetlany tytuł i opis.
   Wyświetl opis	Zaktualizuj opis interfejsu API wyświetlany w katalogu. Domyślnie używany jest opis produktu z interfejsu API. Opis wyświetlania możesz zmienić później, zgodnie z instrukcjami podanymi w artykule Edytuj wyświetlany tytuł i opis.
   Wymagaj od programistów określania adresu URL wywołania zwrotnego	Włącz, jeśli chcesz wymagać od programistów aplikacji określenia adresu URL wywołania zwrotnego. Adres URL wywołania zwrotnego możesz dodać lub zaktualizować w późniejszym czasie zgodnie z instrukcjami podanymi w artykule Zarządzanie adresem URL wywołania zwrotnego interfejsu API.
   Dokumentacja API	Aby użyć dokumentu OpenAPI: Wybierz dokument OpenAPI. Kliknij Wybierz dokument. Wykonaj jedną z tych czynności: Kliknij kartę Moje specyfikacje i wybierz specyfikację ze sklepu ze specyfikacjami. Kliknij kartę Prześlij plik i prześlij plik. Kliknij kartę Importuj z adresu URL i zaimportuj specyfikację z adresu URL. Kliknij Wybierz. Aby użyć schematu GraphQL: Wybierz Schemat GraphQL. Kliknij Wybierz dokument. Przejdź do schematu GraphQL i go wybierz. Kliknij Wybierz. Możesz też wybrać Brak dokumentacji i dodać ją później, gdy interfejs API zostanie dodany, zgodnie z opisem w sekcji Zarządzanie migawką dokumentu.
   Widoczność interfejsu API	Jeśli nie masz zarejestrowanej wersji beta funkcji zarządzania odbiorcami, wybierz jedną z tych opcji: Anonimowi użytkownicy, aby umożliwić wszystkim użytkownikom wyświetlanie interfejsu API. Zarejestrowani użytkownicy, aby umożliwić wyświetlanie interfejsu API tylko zarejestrowanym użytkownikom. Jeśli zapisałeś się do wersji beta funkcji zarządzania odbiorcami, wybierz jedną z tych opcji: Publiczna (widoczna dla każdego), aby umożliwić wszystkim użytkownikom wyświetlanie interfejsu API. Uwierzytelnieni użytkownicy, aby umożliwić wyświetlanie interfejsu API tylko zarejestrowanym użytkownikom. Wybrane listy odbiorców, aby wybrać konkretne listy odbiorców, które mają mieć dostęp do interfejsu API. Później możesz zarządzać widocznością listy odbiorców w sposób opisany w artykule Zarządzanie widocznością interfejsu API w portalu.
   Wyświetlany obrazy	Aby wyświetlić obraz na karcie interfejsu API na stronie interfejsów API, kliknij Wybierz obraz. W oknie Wybierz obraz wybierz istniejący obraz, prześlij nowy obraz lub podaj adres URL zewnętrznego obrazu, a następnie kliknij Wybierz. Wyświetl miniaturę interfejsu API i kliknij Wybierz. Możesz dodać obraz później, zgodnie z instrukcjami podanymi w artykule Zarządzanie obrazem na karcie interfejsu API. Gdy określisz obraz za pomocą zewnętrznego adresu URL, nie zostanie on przesłany do Twoich zasobów. Dodatkowo wczytywanie obrazu w zintegrowanym portalu będzie zależeć od jego dostępności, która może zostać zablokowana lub ograniczona przez zasady bezpieczeństwa treści.
   Kategorie	Dodaj kategorie, którymi zostanie oznaczony interfejs API, aby umożliwić deweloperom aplikacji znajdowanie powiązanych interfejsów API na stronie interfejsów API. Aby zidentyfikować kategorię: Wybierz kategorię z listy. Aby dodać nową kategorię, wpisz jej nazwę i naciśnij Enter. Nowa kategoria zostanie dodana do strony „Kategorie” i będzie dostępna podczas dodawania lub edytowania innych interfejsów API.

7. Kliknij Zapisz.

curl

Aby dodać interfejs API do portalu :

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"
    }'

Zastąp następujące elementy:

• ORG_NAME nazwą organizacji. Na przykład: my-org.
• SITE_ID z nazwą portalu w formacie ORG_NAME-PORTAL_NAME, gdzie ORG_NAME to nazwa organizacji, a PORTAL_NAME to nazwa portalu w postaci wyłącznie małych liter bez spacji i myślników. Na przykład: my-org-myportal.
• ACCESS_TOKEN z tokenem uwierzytelniania używanym do uzyskiwania dostępu do interfejsu Apigee Edge API. Więcej informacji o uwierzytelnianiu i tokenach znajdziesz w artykule Uwierzytelnianie dostępu do interfejsu Edge API.
• TITLE z wyświetlanym tytułem. Na przykład: Hello World 2.
• DESCRIPTION z opisem wyświetlanym na ekranie. Na przykład: Simple hello world example.
• ANON_TRUE_OR_FALSE z true lub false (domyślnie), gdzie: true oznacza, że ten interfejs API jest publicznie widoczny i można go wyświetlać anonimowo; w przeciwnym razie tylko zarejestrowani użytkownicy mogą go wyświetlać.
• IMAGE_URL z adresem URL obrazu zewnętrznego używanego w przypadku produktu w katalogu lub ścieżką do pliku, na przykład plików obrazów przechowywanych na portalu,/files/book-tree.jpg. Gdy podajesz adres URL zewnętrznego obrazu, obraz ten nie zostanie przesłany do Twoich zasobów. Dodatkowo wczytywanie obrazu w zintegrowanym portalu będzie zależeć od jego dostępności, która może być zablokowana lub ograniczona przez zasady bezpieczeństwa treści.
• CALLBACK_TRUE_OR_FALSE z true lub false (domyślnie), gdzie true wymaga od użytkownika portalu podania adresu URL podczas zarządzania aplikacją.
• CATEGORY_ID z identyfikatorem kategorii. Na przykład:bf6505eb-2a0f-47af-a00a-ded40ac72960. Kolejne identyfikatory kategorii oddziel przecinkami. Aby poznać identyfikator kategorii, użyj polecenia list API categories.
• PUBLISHED_TRUE_OR_FALSE z true lub false (domyślnie), gdzie true oznacza, że interfejs API jest dostępny publicznie. Po opublikowaniu możesz zezwolić na dostęp wszystkim użytkownikom, uwierzytelnionym użytkownikom lub określonym użytkownikom.
• API_PRODUCT z nazwą produktu interfejsu API. Na przykład:Hello World 2.

Ładunek odpowiedzi:

{
  "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
}

Gdzie:

• modified: czas ostatniej modyfikacji elementu w katalogu w milisekundach od początku epoki. Na przykład: 1698165480000.
• id: identyfikator produktu w katalogu. Na przykład: 399668.

Interfejs użytkownika

Aby edytować interfejs API:

1. Uzyskaj dostęp do katalogu interfejsów API.
2. Kliknij kartę Interfejsy API, jeśli nie jest jeszcze wybrana.
3. Kliknij wiersz interfejsu API, który chcesz edytować.
4. Kliknij Edytuj.
5. W sekcji Szczegóły interfejsu API wprowadź zmiany. Opcje te opisane są w sekcji Dodawanie interfejsu API.
6. Kliknij Zapisz.

curl

Po dodaniu interfejsu API możesz wprowadzać zmiany za pomocą wywołania update.

W tym przykładzie pokażemy Ci, jak zmienić w portalu opublikowany stan interfejsu API z true na false. W razie potrzeby możesz zmienić więcej niż 1 ustawienie w 1 wywołaniu interfejsu API.

1. Aby znaleźć wygenerowany identyfikator id, który jednoznacznie identyfikuje każdy interfejs API, pobierz listę interfejsów API w portalu zgodnie z opisem w artykule Znajdowanie interfejsów API.

2. Zwracanie bieżących wartości dla konkretnego interfejsu API:

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

   Zastąp następujące elementy:

   • ORG_NAME nazwą organizacji. Na przykład: my-org.
   • SITE_ID z nazwą portalu w formacie ORG_NAME-PORTAL_NAME, gdzie ORG_NAME to nazwa organizacji, a PORTAL_NAME to nazwa portalu w postaci wyłącznie małych liter bez spacji i myślników. Na przykład: my-org-myportal.
   • API_DOC z wygenerowanym id dokumentu. Na przykład:399668. Aby znaleźć tę wartość, użyj polecenia list API docs.
   • ACCESS_TOKEN z tokenem uwierzytelniania używanym do uzyskiwania dostępu do interfejsu Apigee Edge API. Więcej informacji o uwierzytelnianiu i tokenach znajdziesz w artykule Uwierzytelnianie dostępu do interfejsu Edge API.

   Ładunek odpowiedzi:

   {
     "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. Uwzględnij zmienne wartości, które chcesz zachować w wywołaniu update, i zmodyfikuj wartości, które chcesz zmienić. Jeśli pominiesz wiersz, zostanie użyte ustawienie domyślne. W tym przykładzie zmień ustawienie opublikowania z false na 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
    }'
   

   Zastąp następujące elementy:

   • TITLE z wyświetlanym tytułem. Na przykład: Hello World 2.

   Ładunek odpowiedzi:

   {
     "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
   }
   

Interfejs użytkownika

Aby opublikować lub wycofać publikację interfejsu API w portalu:

1. Uzyskaj dostęp do katalogu interfejsów API.
2. Kliknij kartę Interfejsy API, jeśli nie jest jeszcze wybrana.
3. Kliknij wiersz interfejsu API, który chcesz edytować.
4. Kliknij Edytuj.
5. W sekcji Szczegóły interfejsu API zaznacz lub odznacz pole Opublikowano (wyświetlany w katalogu), aby odpowiednio opublikować lub wycofać interfejs API w portalu.
6. Kliknij Zapisz.

curl

W wywołaniu update umieść jedną z tych opcji:

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

Aby edytować interfejs API:

1. Zwracanie bieżących wartości:

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

2. Aby edytować interfejs API, użyj wywołania update. Uwzględnij wartości, które chcesz zmienić, i zmodyfikuj wartości, które chcesz zmienić. Jeśli pominiesz zmienne ustawienie, zostanie ono zastąpione wartością domyślną.

   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
   }

Szczegółowe informacje o krokach, zmiennych i zwracanych danych znajdziesz w artykule Zarządzanie wersją dokumentu.

Interfejs użytkownika

Aby zarządzać widocznością interfejsu API w portalu:

1. Uzyskaj dostęp do katalogu interfejsów API.
2. Kliknij kartę Interfejsy API, jeśli nie jest jeszcze wybrana.
3. Kliknij wiersz interfejsu API, który chcesz edytować.
4. Kliknij Edytuj.

5. Wybierz ustawienie widoczności. Jeśli zapisałeś się do wersji beta funkcji list odbiorców, wybierz jedną z tych opcji:

   • Publiczna (widoczna dla wszystkich), aby umożliwić wszystkim użytkownikom wyświetlanie strony.
   • Uwierzytelnieni użytkownicy, aby umożliwić wyświetlanie strony tylko zarejestrowanym użytkownikom.
   • Wybrane listy odbiorców, aby wybrać konkretne listy odbiorców, które mają mieć możliwość wyświetlania strony. Zapoznaj się z artykułem Zarządzanie odbiorcami portalu.
   W przeciwnym razie wybierz jedną z tych opcji:
   • Anonimowi użytkownicy, aby umożliwić wszystkim użytkownikom wyświetlanie strony.
   • Zarejestrowani użytkownicy, aby zezwolić na wyświetlanie strony tylko zarejestrowanym użytkownikom.

6. Kliknij Prześlij.

curl

Jeśli zapisałeś się do wersji beta funkcji zarządzania listami odbiorców, możesz zarządzać listami odbiorców za pomocą interfejsu użytkownika.

Jeśli nie korzystasz z funkcji zarządzania odbiorcami, widoczność jest zarządzana za pomocą anonAllowed.

W wywołaniu updateuwzględnij jedną z tych opcji:

  # 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

Aby edytować interfejs API:

1. Zwracanie bieżących wartości:

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

2. Aby edytować interfejs API, użyj wywołania update. Uwzględnij wartości, które chcesz zachować, a zmodyfikuj wartości, które chcesz zmienić. Jeśli pominiesz zmienne ustawienie, zostanie użyta wartość domyślna.

   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
        }'

Szczegółowe informacje o krokach, zmiennych i zwracanych danych znajdziesz w artykule Edytuj interfejs API.

Interfejs użytkownika

Aby zarządzać adresem URL wywołania zwrotnego interfejsu API:

1. Uzyskaj dostęp do katalogu interfejsów API.
2. Kliknij kartę Interfejsy API, jeśli nie jest jeszcze wybrana.
3. Kliknij wiersz interfejsu API, który chcesz edytować.
4. Kliknij Edytuj.
5. W sekcji Szczegóły interfejsu API zaznacz lub odznacz pole wyboru Wymagaj od programistów określania adresu URL wywołania zwrotnego.
6. Kliknij Zapisz.

curl

W wywołaniu updateuwzględnij jedną z tych opcji:

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

Aby edytować interfejs API:

1. Zwracanie bieżących wartości:

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

2. Aby edytować interfejs API, użyj wywołania update. Uwzględnij wartości, które chcesz zachować, a zmodyfikuj wartości, które chcesz zmienić. Jeśli pominiesz zmienne ustawienie, zostanie użyta wartość domyślna.

   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
        }'

Szczegółowe informacje o krokach, zmiennych i zwracanych danych znajdziesz w artykule Edytuj interfejs API.

Interfejs użytkownika

Aby zarządzać obrazem karty interfejsu API:

1. Uzyskaj dostęp do katalogu interfejsów API.
2. Kliknij kartę Interfejsy API, jeśli nie jest jeszcze wybrana.
3. Kliknij wiersz interfejsu API, który chcesz edytować.
4. Kliknij Edytuj.

5. W sekcji Szczegóły interfejsu API:

   • Kliknij Wybierz obraz, aby wskazać lub przesłać obraz, jeśli żaden nie został wybrany.
   • Aby wybrać lub przesłać inny obraz, kliknij Zmień obraz.
   • Aby usunąć obraz, kliknij x.

   Podczas wskazywania obrazu podaj albo obraz z zewnętrznym adresem URL używanym dla elementu katalogu, albo ścieżkę do pliku obrazu przechowywanego w portalu, np. /files/book-tree.jpg. Gdy określisz adres URL obrazu zewnętrznego, nie zostanie on przesłany do Twoich zasobów. Ponadto wczytywanie obrazu w zintegrowanym portalu będzie zależeć od jego dostępności, która może zostać zablokowana lub ograniczona przez zasady bezpieczeństwa treści.

6. Kliknij Zapisz.

curl

W wywołaniu update należy uwzględnić:

  # Omit line for no image file

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

Aby edytować interfejs API:

1. Zwracanie bieżących wartości:

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

2. Aby edytować interfejs API, użyj wywołania update. Uwzględnij wartości, które chcesz zachować, a zmodyfikuj wartości, które chcesz zmienić. Jeśli pominiesz zmienne ustawienie, zostanie użyta wartość domyślna.

   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
        }'

Szczegółowe informacje o krokach, zmiennych i zwracanych danych znajdziesz w artykule Edytuj interfejs API.

Interfejs użytkownika

Aby podczas edytowania interfejsu API dodać do niego tagi kategorii:

1. Uzyskaj dostęp do katalogu interfejsów API.
2. Kliknij kartę Interfejsy API, jeśli nie jest jeszcze wybrana.
3. Kliknij wiersz interfejsu API, który chcesz edytować.
4. Kliknij Edytuj.
5. Kliknij pole Kategorie i wykonaj jedną z tych czynności:
   • Wybierz kategorię z listy.
   • Aby dodać nową kategorię, wpisz jej nazwę i naciśnij Enter. Nowa kategoria zostanie dodana do strony „Kategorie” i będzie dostępna podczas dodawania lub edytowania innych interfejsów API.
6. Powtórz tę czynność, aby dodać tagi do interfejsu API w większej liczbie kategorii.
7. Kliknij Zapisz.

curl

W wywołaniu update należy uwzględnić:

  # Omit line for no categories

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

Aby uzyskać numery identyfikatorów kategorii, użyj polecenia list categories.

Aby edytować interfejs API:

1. Zwracanie bieżących wartości:

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

2. Aby edytować interfejs API, użyj wywołania update. Uwzględnij wartości, które chcesz zachować, a zmodyfikuj wartości, które chcesz zmienić. Jeśli pominiesz zmienne ustawienie, zostanie użyta wartość domyślna.

   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
        }'

Szczegółowe informacje o krokach, zmiennych i zwracanych danych znajdziesz w artykule Edytuj interfejs API.

Interfejs użytkownika

Aby edytować wyświetlany tytuł i opis:

1. Uzyskaj dostęp do katalogu interfejsów API.
2. Kliknij kartę Interfejsy API, jeśli nie jest jeszcze wybrana.
3. Kliknij wiersz interfejsu API, który chcesz edytować.
4. Kliknij Edytuj.
5. W razie potrzeby zmień pola Wyświetlany tytuł i Wyświetlany opis.
6. Kliknij Zapisz.

curl

W wywołaniu update należy uwzględnić:

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

Aby edytować interfejs API:

1. Zwracanie bieżących wartości:

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

2. Aby edytować interfejs API, użyj wywołania update. Uwzględnij wartości, które chcesz zachować, a zmodyfikuj wartości, które chcesz zmienić. Jeśli pominiesz zmienne ustawienie, zostanie użyta wartość domyślna.

   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
        }'

Szczegółowe informacje o krokach, zmiennych i zwracanych danych znajdziesz w artykule Edytuj interfejs API.

Interfejs użytkownika

Aby usunąć interfejs API z portalu:

1. Uzyskaj dostęp do katalogu interfejsów API.
2. Wybierz Interfejsy API (jeśli nie są już wybrane).
3. Umieść kursor na interfejsie API na liście, aby wyświetlić menu działań.
4. Kliknij  Usuń.

curl

Aby usunąć interfejs API z portalu:

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

Zastąp następujące elementy:

• ORG_NAME nazwą organizacji. Na przykład: my-org.
• SITE_ID z nazwą portalu w formacie ORG_NAME-PORTAL_NAME, gdzie ORG_NAME to nazwa organizacji, a PORTAL_NAME to nazwa portalu w postaci wyłącznie małych liter bez spacji i myślników. Na przykład: my-org-myportal.
• API_DOC z wygenerowanym id dokumentu. Na przykład:399668. Aby znaleźć tę wartość, użyj polecenia list API docs.
• ACCESS_TOKEN z tokenem uwierzytelniania używanym do uzyskiwania dostępu do interfejsu Apigee Edge API. Więcej informacji o uwierzytelnianiu i tokenach znajdziesz w artykule Uwierzytelnianie dostępu do interfejsu Edge API.

Ładunek odpowiedzi:

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

Interfejs użytkownika

1. Uzyskaj dostęp do katalogu interfejsów API.
2. Kliknij kartę Interfejsy API, jeśli nie jest jeszcze wybrana.
3. Kliknij wiersz interfejsu API, który chcesz edytować.
4. Sprawdź stan zrzutu. Jeśli jest nieaktualny, wyświetli się ten komunikat:
5. Kliknij edit Edytuj.
6. Wykonaj jedną z tych czynności:
   • Aby odświeżyć nieaktualny zrzut dokumentu OpenAPI, kliknij Odśwież zrzut.
   • Aby zmienić dokument używany do generowania dokumentacji interfejsu API, w sekcji Dokumentacja interfejsu API kliknij Wybierz dokument i wybierz nowy dokument.
7. W panelu Dokumentacja interfejsu API wybierz jedną z tych opcji:
   • Dokument OpenAPI
   • Schemat GraphQL
8. Kliknij Wybierz dokument i wybierz najnowszą wersję dokumentu.
9. W przypadku GraphQL podaj adres URL punktu końcowego.
10. Kliknij Zapisz.

Dokumentacja referencyjna interfejsu API jest renderowana z dokumentu i dodawana do strony referencyjnej interfejsu API. Stan zrzutu jest aktualizowany do bieżącego:

curl

Aby zaktualizować zawartość dokumentacji OpenAPI lub GraphQL:

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
}

Interfejs użytkownika

curl

Aby pobrać dokumentację interfejsu API za pomocą funkcji get documentation:

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

Zastąp następujące elementy:

• ORG_NAME nazwą organizacji. Na przykład: my-org.
• SITE_ID z nazwą portalu w formacie ORG_NAME-PORTAL_NAME, gdzie ORG_NAME to nazwa organizacji, a PORTAL_NAME to nazwa portalu w postaci wyłącznie małych liter bez spacji i myślników. Na przykład: my-org-myportal.

• API_DOC z wygenerowanym id dokumentu. Na przykład:399668. Aby znaleźć tę wartość, użyj polecenia list API docs.

  Ładunek odpowiedzi:

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

Gdzie:

contents: zakodowany w formacie base64 ciąg znaków z dokumentacją interfejsu API.

Interfejs użytkownika

1. Uzyskaj dostęp do katalogu interfejsów API.
2. Kliknij kartę Interfejsy API, jeśli nie jest jeszcze wybrana.
3. Kliknij wiersz interfejsu API, który chcesz edytować.
4. Kliknij edit Edytuj.
5. W panelu Dokumentacja interfejsu API wybierz Brak dokumentacji.
6. Kliknij Zapisz.

curl

Aby usunąć istniejące treści, użyj interfejsu update API:

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 '{}'

Zastąp następujące elementy:

• ORG_NAME nazwą organizacji. Na przykład: my-org.
• SITE_ID z nazwą portalu w formacie ORG_NAME-PORTAL_NAME, gdzie ORG_NAME to nazwa organizacji, a PORTAL_NAME to nazwa portalu w postaci wyłącznie małych liter bez spacji i myślników. Na przykład: my-org-myportal.
• API_DOC z wygenerowanym id dokumentu. Na przykład:399668. Aby znaleźć tę wartość, użyj polecenia list API docs.

Ładunek odpowiedzi:

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

Interfejs użytkownika

Aby wyświetlić stronę Kategorie:

1. Kliknij Opublikuj > Portale, a następnie wybierz swój portal.
2. Na stronie głównej portalu kliknij Katalog interfejsów API.

   Możesz też wybrać Katalog interfejsów API w menu portalu w górnym pasku nawigacji.

3. Kliknij kartę Kategorie.

Karta Kategorie w katalogu interfejsu API zawiera listę kategorii zdefiniowanych dla Twojego portalu.

Jak widać na poprzednim rysunku, na stronie Interfejsy API możesz:

• Wyświetlanie kategorii i interfejsów API, do których zostały one przypisane
• Dodaj kategorię
• Edytowanie kategorii
• Usuwanie kategorii
• zarządzać interfejsami API opublikowanymi w Twoim portalu; Zapoznaj się z  katalogiem interfejsów API

curl

Aby wyświetlić kategorie:

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

Zastąp następujące elementy:

• ORG_NAME nazwą organizacji. Na przykład: my-org.
• SITE_ID z nazwą portalu w formacie ORG_NAME-PORTAL_NAME, gdzie ORG_NAME to nazwa organizacji, a PORTAL_NAME to nazwa portalu w postaci wyłącznie małych liter bez spacji i myślników. Na przykład: my-org-myportal.
• ACCESS_TOKEN z tokenem uwierzytelniania używanym do uzyskiwania dostępu do interfejsu Apigee Edge API. Więcej informacji o uwierzytelnianiu i tokenach znajdziesz w artykule Uwierzytelnianie dostępu do interfejsu Edge API.

Ładunek odpowiedzi:

{
  "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
}

Gdzie:

• id: identyfikator elementu kategorii. Na przykład: 61c1014c-89c9-40e6-be3c-69cca3505620.

Interfejs użytkownika

Aby ręcznie dodać kategorię:

1. Otwórz stronę Kategorie.
2. Kliknij + Dodaj.
3. Wpisz nazwę nowej kategorii.
4. Opcjonalnie wybierz co najmniej 1 interfejs API, który chcesz dodać do tej kategorii.
5. Kliknij Utwórz.

curl

Aby dodać kategorię:

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" }'

Zastąp następujące elementy:

• ORG_NAME nazwą organizacji. Na przykład: my-org.
• SITE_ID z nazwą portalu w formacie ORG_NAME-PORTAL_NAME, gdzie ORG_NAME to nazwa organizacji, a PORTAL_NAME to nazwa portalu w postaci wyłącznie małych liter bez spacji i myślników. Na przykład: my-org-myportal.
• ACCESS_TOKEN z tokenem uwierzytelniania używanym do uzyskiwania dostępu do interfejsu Apigee Edge API. Więcej informacji o uwierzytelnianiu i tokenach znajdziesz w artykule Uwierzytelnianie dostępu do interfejsu Edge API.
• CATEGORY_NAME z nazwą kategorii. Na przykład: demo-backend.

Ładunek odpowiedzi:

{
  "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
}

Interfejs użytkownika

Aby edytować kategorię:

1. Otwórz stronę Kategorie.
2. Kliknij Edytuj.
3. Zmień nazwę kategorii.
4. Dodawanie i usuwanie tagów API.
5. Kliknij Zapisz.

curl

Aby edytować kategorię:

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" }'

Zastąp następujące elementy:

• ORG_NAME nazwą organizacji. Na przykład: my-org.
• SITE_ID z nazwą portalu w formacie ORG_NAME-PORTAL_NAME, gdzie ORG_NAME to nazwa organizacji, a PORTAL_NAME to nazwa portalu w postaci wyłącznie małych liter bez spacji i myślników. Na przykład: my-org-myportal.
• CATEGORY_ID z identyfikatorem kategorii. Na przykład:bf6505eb-2a0f-47af-a00a-ded40ac72960. Kolejne identyfikatory kategorii oddziel przecinkami. Aby poznać identyfikator kategorii, użyj polecenia list API categories.
• ACCESS_TOKEN z tokenem uwierzytelniania używanym do uzyskiwania dostępu do interfejsu Apigee Edge API. Więcej informacji o uwierzytelnianiu i tokenach znajdziesz w artykule Uwierzytelnianie dostępu do interfejsu Edge API.
• CATEGORY_NAME z nazwą kategorii. Na przykład: demo-backend.

Ładunek odpowiedzi:

{
  "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
}

Interfejs użytkownika

Aby usunąć kategorię:

1. Otwórz stronę Kategorie.
2. Umieść kursor nad kategorią, którą chcesz edytować, aby wyświetlić menu działań.
3. Kliknij  Usuń.
4. Kliknij Usuń, aby potwierdzić.

curl

Aby usunąć kategorię:

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"

Zastąp następujące elementy:

• ORG_NAME nazwą organizacji. Na przykład: my-org.
• SITE_ID z nazwą portalu w formacie ORG_NAME-PORTAL_NAME, gdzie ORG_NAME to nazwa organizacji, a PORTAL_NAME to nazwa portalu w postaci wyłącznie małych liter bez spacji i myślników. Na przykład: my-org-myportal.
• CATEGORY_ID z identyfikatorem kategorii. Na przykład: bf6505eb-2a0f-47af-a00a-ded40ac72960. Aby poznać identyfikator kategorii, użyj polecenia list API categories.
• ACCESS_TOKEN z tokenem uwierzytelniania używanym do uzyskiwania dostępu do interfejsu Apigee Edge API. Więcej informacji o uwierzytelnianiu i tokenach znajdziesz w artykule Uwierzytelnianie dostępu do interfejsu Edge API.

Ładunek odpowiedzi:

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