Publikowanie interfejsów API

UI

Aby wyświetlić katalog interfejsów API:

1. Kliknij Opublikuj > Portale i wybierz 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 wyświetlana jest lista interfejsów API, które zostały dodane do portalu.

Jak pokazano na poprzednim rysunku, karta Interfejsy API umożliwia:

• wyświetlać szczegółowe informacje o interfejsach API dostępnych w portalu,
• Dodawanie interfejsu API do portalu
• Edytuj interfejs API w portalu, wykonując co najmniej jedno z tych zadań:
  • Zarządzanie migawką dokumentu powiązanego z usługą interfejsu API w celu zaktualizowania dokumentacji 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 karty interfejsu API
  • Tagowanie interfejsu API za pomocą kategorii
  • Edytowanie tytułu i opisu interfejsu API
• Usuwanie interfejsu API z portalu
• Zarządzanie kategoriami używanymi do wykrywania powiązanych interfejsów API
• Szybkie wykrywanie specyfikacji, które są nieaktualne lub zostały usunięte ze sklepu ze specyfikacjami.
• Szybko identyfikuj osierocone interfejsy API, których powiązana usługa API została usunięta z Apigee Edge, i ponownie utwórz usługę API lub usuń 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 te elementy:

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

Instrukcje dotyczące korzystania ze stronicowania w ładunku odpowiedzi znajdziesz w sekcji Uwagi dotyczące stronicowania.

Ł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 katalogu w milisekundach od początku epoki. Na przykład: 1698165480000.
• id: identyfikator produktu w katalogu. Na przykład: 399668.

Uwagi dotyczące podziału na strony:

• Rozmiar strony: użyj pageSize, aby określić liczbę elementów listy do zwrócenia na jednej stronie. Wartość domyślna to 25, a maksymalna – 100. Jeśli są dodatkowe strony, parametr nextPageToken jest wypełniany tokenem:

  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, podając 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 pageToken, aby pobrać kolejne strony, jeśli jest ich więcej niż jedna:

  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, podając liczbę elementów listy do zwrócenia na jednej stronie. Na przykład 10.
  • PAGE_TOKEN z wartością nextPageToken. Na przykład: 7zcqrin9l6xhi4nbrb9.

UI

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.

   Pojawi się okno Dodaj usługę interfejsu 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 API i jej widoczność w portalu:

   Pole	Opis
   Opublikowano	Wybierz Opublikowano, aby opublikować interfejs API w portalu. Jeśli nie chcesz jeszcze publikować interfejsu API, odznacz to pole wyboru. Możesz zmienić to ustawienie później, jak opisano w artykule Publikowanie i cofanie publikacji interfejsu API w portalu.
   Wyświetl tytuł	Zaktualizuj tytuł interfejsu API wyświetlany w katalogu. Domyślnie używana jest nazwa produktu API. Możesz później zmienić wyświetlany tytuł, jak opisano w artykule Edytowanie wyświetlanego tytułu i opisu.
   Wyświetl opis	Zaktualizuj opis interfejsu API wyświetlany w katalogu. Domyślnie używany jest opis usługi API. Możesz zmienić opis później, jak opisano w artykule Edytowanie wyświetlanej nazwy i opisu.
   Wymagaj od programistów określania adresu URL wywołania zwrotnego	Włącz, jeśli chcesz wymagać od deweloperów aplikacji określenia adresu URL wywołania zwrotnego. Adres URL wywołania zwrotnego możesz dodać lub zaktualizować później, zgodnie z opisem 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 wybierz go. Kliknij Wybierz. Możesz też wybrać Brak dokumentacji i dodać ją później, po dodaniu interfejsu API, zgodnie z opisem w sekcji Zarządzanie migawką dokumentu.
   Widoczność interfejsu API	Jeśli nie korzystasz z wersji beta funkcji zarządzania odbiorcami, wybierz jedną z tych opcji: Użytkownicy anonimowi, aby umożliwić wszystkim użytkownikom wyświetlanie interfejsu API. Zarejestrowani użytkownicy, aby zezwolić na wyświetlanie interfejsu API tylko zarejestrowanym użytkownikom. Jeśli zarejestrujesz się w wersji beta funkcji zarządzania odbiorcami, wybierz jedną z tych opcji: Publiczne (widoczne dla każdego), aby umożliwić wszystkim użytkownikom wyświetlanie interfejsu API. Uwierzytelnieni użytkownicy, aby zezwolić na wyświetlanie interfejsu API tylko zarejestrowanym użytkownikom. Wybrani odbiorcy, aby wybrać konkretnych odbiorców, którzy mają mieć możliwość wyświetlania interfejsu API. Widocznością dla odbiorców możesz zarządzać później, zgodnie z opisem w artykule Zarządzanie widocznością interfejsu API w portalu.
   Wyświetlany obrazy	Aby wyświetlić obraz na karcie interfejsu API na stronie Interfejsy API, kliknij Wybierz obraz. W oknie Wybierz obraz wybierz istniejący obraz, prześlij nowy obraz lub podaj adres URL obrazu zewnętrznego i kliknij Wybierz. Wyświetl podgląd miniatury interfejsu API i kliknij Wybierz. Możesz dodać obraz później, jak opisano w artykule Zarządzanie obrazem na karcie interfejsu API. Jeśli określisz obraz z zewnętrznym adresem 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 być zablokowana lub ograniczona przez zasady bezpieczeństwa treści.
   Kategorie	Dodaj kategorie, do których zostanie przypisany interfejs API, aby umożliwić deweloperom aplikacji odkrywanie powiązanych interfejsów API na stronie Interfejsy API. Aby określić kategorię: Wybierz kategorię z listy. Dodaj nową kategorię, wpisując jej nazwę i naciskając 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 te elementy:

• ORG_NAME nazwą organizacji. Na przykład: my-org.
• SITE_ID z nazwą portalu w postaci ORG_NAME-PORTAL_NAME, gdzie ORG_NAME to nazwa organizacji, a PORTAL_NAME to nazwa portalu przekonwertowana na małe litery, bez spacji i myślników. Na przykład: my-org-myportal.
• ACCESS_TOKEN tokenem uwierzytelniania używanym do uzyskiwania dostępu do interfejsu API Apigee Edge. Więcej informacji o uwierzytelnianiu i tokenach znajdziesz w artykule Uwierzytelnianie dostępu do interfejsu API Edge.
• TITLE z wyświetlanym tytułem. Na przykład: Hello World 2.
• DESCRIPTION z opisem wyświetlanym. 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 widoczny publicznie i można go wyświetlać anonimowo; w przeciwnym razie mogą go wyświetlać tylko zarejestrowani użytkownicy.
• IMAGE_URL adresem URL obrazu zewnętrznego używanego w przypadku elementu katalogu lub ścieżką do plików graficznych przechowywanych w portalu, np. /files/book-tree.jpg. Jeśli podasz adres URL obrazu zewnętrznego, obraz nie zostanie przesłany do 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 wpisania adresu URL podczas zarządzania aplikacją.
• CATEGORY_ID identyfikatorem kategorii. Na przykład: bf6505eb-2a0f-47af-a00a-ded40ac72960. Kolejne identyfikatory kategorii oddziel przecinkami. Pobierz identyfikator kategorii za pomocą 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 nazwą usługi 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 katalogu w milisekundach od początku epoki. Na przykład: 1698165480000.
• id: identyfikator produktu w katalogu. Na przykład: 399668.

UI

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. Opisy opcji znajdziesz w artykule Dodawanie interfejsu API.
6. Kliknij Zapisz.

curl

Po dodaniu interfejsu API użyj wywołania update, aby wprowadzić zmiany.

W tym przykładzie dowiesz się, jak zmienić stan opublikowania interfejsu API w portalu z true na false. W razie potrzeby możesz zmienić więcej niż jedno ustawienie w jednym 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 Przeglądanie 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 te elementy:

   • ORG_NAME nazwą organizacji. Na przykład: my-org.
   • SITE_ID z nazwą portalu w postaci ORG_NAME-PORTAL_NAME, gdzie ORG_NAME to nazwa organizacji, a PORTAL_NAME to nazwa portalu przekonwertowana na małe litery, 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 tokenem uwierzytelniania używanym do uzyskiwania dostępu do interfejsu API Apigee Edge. Więcej informacji o uwierzytelnianiu i tokenach znajdziesz w artykule Uwierzytelnianie dostępu do interfejsu API Edge.

   Ł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. W wywołaniu update uwzględnij wartości zmienne, które chcesz zachować, i zmodyfikuj wartości, które chcesz zmienić. Jeśli pominiesz wiersz, zostanie użyte ustawienie domyślne. W tym przykładzie zmień ustawienie opublikowanej wersji 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 te 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
   }
   

UI

Aby opublikować interfejs API w portalu lub cofnąć jego publikację:

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 Opublikowany (na liście w katalogu), aby opublikować interfejs API w portalu lub go z niego usunąć.
6. Kliknij Zapisz.

curl

W wywołaniu aktualizacji uwzględnij 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. Zwróć bieżące 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 zmienne, które chcesz zachować, i zmodyfikuj te, które chcesz zmienić. Jeśli pominiesz ustawienie, które można zmienić, 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ółowy przykład kroków, zmiennych i zwracanych danych znajdziesz w artykule Zarządzanie wersją dokumentu.

UI

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 zarejestrujesz się w wersji beta funkcji list odbiorców, wybierz jedną z tych opcji:

   • Publiczna (widoczna dla każdego), aby wszyscy użytkownicy mogli wyświetlać stronę.
   • Uwierzytelnieni użytkownicy, aby zezwolić na wyświetlanie strony tylko zarejestrowanym użytkownikom.
   • Wybrani odbiorcy, aby wybrać konkretnych odbiorców, którzy mają mieć możliwość wyświetlania strony. Więcej informacji znajdziesz w artykule Zarządzanie odbiorcami portalu.
   W przeciwnym razie wybierz jedną z tych opcji:
   • Użytkownicy anonimowi, 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 zarejestrujesz się w wersji beta funkcji zarządzania odbiorcami, możesz zarządzać odbiorcami w interfejsie.

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

W wywołaniu update uwzględnij jedną z tych wartości:

  # 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. Zwróć bieżące 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 zmienne, które chcesz zachować, i zmodyfikuj te, które chcesz zmienić. Jeśli pominiesz ustawienie, które można zmienić, 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ółowy przykład kroków, zmiennych i zwracanych danych znajdziesz w artykule Edytowanie interfejsu API.

UI

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 update uwzględnij jedną z tych wartości:

  "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. Zwróć bieżące 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 zmienne, które chcesz zachować, i zmodyfikuj te, które chcesz zmienić. Jeśli pominiesz ustawienie, które można zmienić, 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ółowy przykład kroków, zmiennych i zwracanych danych znajdziesz w artykule Edytowanie interfejsu API.

UI

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 nie został wybrany.
   • Kliknij Zmień obraz, aby wybrać lub przesłać inny obraz.
   • Kliknij x na obrazie, aby go usunąć.

   Podczas określania obrazu podaj obraz z zewnętrznym adresem URL używanym w przypadku elementu katalogu lub ścieżkę do plików graficznych przechowywanych w portalu, np. /files/book-tree.jpg. Jeśli podasz adres URL obrazu zewnętrznego, obraz 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ć blokowana lub ograniczana przez zasady bezpieczeństwa treści.

6. Kliknij Zapisz.

curl

W wywołaniu update uwzględnij te elementy:

  # 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. Zwróć bieżące 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 zmienne, które chcesz zachować, i zmodyfikuj te, które chcesz zmienić. Jeśli pominiesz ustawienie, które można zmienić, 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ółowy przykład kroków, zmiennych i zwracanych danych znajdziesz w artykule Edytowanie interfejsu API.

UI

Aby otagować interfejs API kategoriami podczas jego edytowania:

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.
   • Dodaj nową kategorię, wpisując jej nazwę i naciskając 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 otagować interfejs API w większej liczbie kategorii.
7. Kliknij Zapisz.

curl

W wywołaniu update uwzględnij te elementy:

  # Omit line for no categories

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

Aby uzyskać numery identyfikacyjne kategorii, użyj polecenia list categories.

Aby edytować interfejs API:

1. Zwróć bieżące 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 zmienne, które chcesz zachować, i zmodyfikuj te, które chcesz zmienić. Jeśli pominiesz ustawienie, które można zmienić, 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ółowy przykład kroków, zmiennych i zwracanych danych znajdziesz w artykule Edytowanie interfejsu API.

UI

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 uwzględnij te elementy:

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

Aby edytować interfejs API:

1. Zwróć bieżące 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 zmienne, które chcesz zachować, i zmodyfikuj te, które chcesz zmienić. Jeśli pominiesz ustawienie, które można zmienić, 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ółowy przykład kroków, zmiennych i zwracanych danych znajdziesz w artykule Edytowanie interfejsu API.

UI

Aby usunąć interfejs API z portalu:

1. Uzyskaj dostęp do katalogu interfejsów API.
2. Wybierz Interfejsy API, jeśli nie są jeszcze wybrane.
3. Najedź kursorem na interfejs API na liście, aby wyświetlić menu czynności.
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 te elementy:

• ORG_NAME nazwą organizacji. Na przykład: my-org.
• SITE_ID z nazwą portalu w postaci ORG_NAME-PORTAL_NAME, gdzie ORG_NAME to nazwa organizacji, a PORTAL_NAME to nazwa portalu przekonwertowana na małe litery, 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 tokenem uwierzytelniania używanym do uzyskiwania dostępu do interfejsu API Apigee Edge. Więcej informacji o uwierzytelnianiu i tokenach znajdziesz w artykule Uwierzytelnianie dostępu do interfejsu API Edge.

Ładunek odpowiedzi:

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

UI

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 nieaktualna, wyświetli się ten komunikat:
5. Kliknij edit Edytuj.
6. Wykonaj jedną z tych czynności:
   • Aby odświeżyć zrzut dokumentu OpenAPI, który jest nieaktualny, 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 API wybierz jedną z tych opcji:
   • dokument OpenAPI
   • Schemat GraphQL
8. Kliknij Wybierz dokument i wybierz najnowszą wersję dokumentu.
9. W przypadku GraphQL podaj URL punktu końcowego.
10. Kliknij Zapisz.

Dokumentacja API jest renderowana z dokumentu i dodawana do strony dokumentacji API. Stan zrzutu zostanie zaktualizowany do bieżącego:

curl

Aby zaktualizować treść 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
}

UI

curl

Aby pobrać dokumentację interfejsu API za pomocą metody 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 te elementy:

• ORG_NAME nazwą organizacji. Na przykład: my-org.
• SITE_ID z nazwą portalu w postaci ORG_NAME-PORTAL_NAME, gdzie ORG_NAME to nazwa organizacji, a PORTAL_NAME to nazwa portalu przekonwertowana na małe litery, 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: ciąg znaków zakodowany w formacie base64, który zawiera treść dokumentacji API.

UI

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 API wybierz Brak dokumentacji.
6. Kliknij Zapisz.

curl

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

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 te elementy:

• ORG_NAME nazwą organizacji. Na przykład: my-org.
• SITE_ID z nazwą portalu w postaci ORG_NAME-PORTAL_NAME, gdzie ORG_NAME to nazwa organizacji, a PORTAL_NAME to nazwa portalu przekonwertowana na małe litery, 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
}

UI

Aby wyświetlić stronę Kategorie:

1. Kliknij Opublikuj > Portale i wybierz 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.

3. Kliknij kartę Kategorie.

Na karcie Kategorie w katalogu interfejsów API wyświetlana jest lista kategorii zdefiniowanych dla Twojego portalu.

Jak pokazano na poprzednim rysunku, na stronie interfejsów API możesz:

• Wyświetlanie kategorii i interfejsów API, do których są otagowane
• Dodaj kategorię
• Edytowanie kategorii
• Usuwanie kategorii
• Zarządzaj interfejsami API opublikowanymi w portalu. Zobacz Przeglądanie katalogu interfejsów API.

curl

Aby wyświetlić listę kategorii:

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

Zastąp te elementy:

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

Ł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.

UI

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 oznaczyć tagiem 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 te elementy:

• ORG_NAME nazwą organizacji. Na przykład: my-org.
• SITE_ID z nazwą portalu w postaci ORG_NAME-PORTAL_NAME, gdzie ORG_NAME to nazwa organizacji, a PORTAL_NAME to nazwa portalu przekonwertowana na małe litery, bez spacji i myślników. Na przykład: my-org-myportal.
• ACCESS_TOKEN tokenem uwierzytelniania używanym do uzyskiwania dostępu do interfejsu API Apigee Edge. Więcej informacji o uwierzytelnianiu i tokenach znajdziesz w artykule Uwierzytelnianie dostępu do interfejsu API Edge.
• CATEGORY_NAME 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
}

UI

Aby edytować kategorię:

1. Otwórz stronę Kategorie.
2. Kliknij Edytuj.
3. Zmień nazwę kategorii.
4. Dodaj lub usuń tagi interfejsu 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 te elementy:

• ORG_NAME nazwą organizacji. Na przykład: my-org.
• SITE_ID z nazwą portalu w postaci ORG_NAME-PORTAL_NAME, gdzie ORG_NAME to nazwa organizacji, a PORTAL_NAME to nazwa portalu przekonwertowana na małe litery, bez spacji i myślników. Na przykład: my-org-myportal.
• CATEGORY_ID identyfikatorem kategorii. Na przykład: bf6505eb-2a0f-47af-a00a-ded40ac72960. Kolejne identyfikatory kategorii oddziel przecinkami. Pobierz identyfikator kategorii za pomocą polecenia list API categories.
• ACCESS_TOKEN tokenem uwierzytelniania używanym do uzyskiwania dostępu do interfejsu API Apigee Edge. Więcej informacji o uwierzytelnianiu i tokenach znajdziesz w artykule Uwierzytelnianie dostępu do interfejsu API Edge.
• CATEGORY_NAME 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
}

UI

Aby usunąć kategorię:

1. Otwórz stronę Kategorie.
2. Umieść kursor nad kategorią, którą chcesz edytować, aby wyświetlić menu czynności.
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 te elementy:

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

Ładunek odpowiedzi:

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