Content Services GraphQLinterfejs API

Edycja w trybie z połączeniem

Interfejs API służy do tworzenia, pobierania, aktualizowania lub usuwania zasobów. Interfejs API jest idealny do tworzenia aplikacji WWW i aplikacji mobilnych, ponieważ obsługuje pobieranie (za pomocą jednego wywołania) dokładnie tych danych, których potrzebujesz. Domyślnie ten interfejs API jest udostępniany w ramach subskrypcji.

Przegląd

Interfejs API Content Services GraphQL udostępnia schemat i łatwy w zrozumieniu system języka zapytań, który upraszcza programowanie aplikacji dla produktu Content Platform Engine. Definicja schematu interfejsu API dotycząca typów i pól jest zgodna z modelem obiektu Content Engine Java API oraz zawiera niezbędne i pożądane rozszerzenia, które są standardowo używane przez programistów używających języka GraphQL.

Interfejs API obejmuje następujące operacje:
  • Wykrywanie metadanych
  • Operacje na dokumentach i folderach
  • Operacje wyszukiwania
  • Operacje przeglądania
Dostęp do punktu końcowego interfejsu API można uzyskać za pomocą jednego z następujących adresów URL. Użyj adresu URL, który ma zastosowanie do konfiguracji subskrypcji.
  • https://hostname.automationcloud.ibm.com.com/dba/environment/content-services-graphql/graphql
  • https://fncm-environment-hostname.automationcloud.ibm.com/content-services-graphql/graphql
gdzie środowisko ma wartość dev dla środowiska programistycznego, test dla środowiska testowego lub run dla środowiska produkcyjnego.
Interfejs API zawiera zintegrowane środowisko programistyczne w przeglądarce (GraphiQL), które ułatwia eksplorację interfejsu API i interakcję z nim. W zależności od konfiguracji subskrypcji, należy uzyskać dostęp do zintegrowanego środowiska programistycznego za pomocą jednego z następujących adresów URL:
  • https://hostname.automationcloud.ibm.com/dba/environment/content-services-graphql/
  • https://fncm-environment-hostname.automationcloud.ibm.com/content-services-graphql/
Adres URL musi kończyć się znakiem "/".
Uwaga: zintegrowane środowisko programistyczne nie jest dostępne w środowisku produkcyjnym.

Wszystkie aplikacje, które korzystają z interfejsu API GraphQL , muszą przekazywać znacznik ECM-CS-XSRF-Token w nagłówku i informacji cookie. Zaleca się, aby klient GraphQL wygenerował znacznik, ustawia go jako informację cookie w przeglądarce klienta i zapisuje tę samą wartość w sesji użytkownika. Gdy pojawi się żądanie klienta, klient GraphQL sprawdza poprawność informacji cookie systemu ECM-CS-XSRF-Token w stosunku do zapisanej wartości. Gdy żądanie jest przekazywane do Content Services GraphQL, te wartości znajdują się w nagłówku ECM-CS-XSRF-Token i cookie EM-CS-XSRF-Token.

Testowanie połączenia z interfejsem API

Po uzysku dostępu do instancji GraphQL dla interfejsu API można przetestować połączenie z Content Platform Engine , jak to pokazano w poniższym przykładzie.
{
  _apiInfo(repositoryIdentifier: "OS1") {
    buildDate
    buildNumber
    implementationVersion
    implementationTitle
    productVersion
    cpeInfo {
      cpeURL
      cpeUser
      repositoryName
    }
  }
}
Wartością dla repositoryIdentifier jest nazwa składnicy obiektów Content Platform Engine (nazwa symboliczna) lub ID (GUID).
Pomyślnie nawiązano połączenie z odpowiedzią podobną do poniższego przykładu.
{
 "data": {
  "_apiInfo": {
  "buildDate": "February 28, 2020 at 09:20",
  "buildNumber": "29",
  "implementationVersion": "20200228-0920-29-pwtest330",
  "implementationTitle": "IBM FileNet Content Services GraphQL API - content-graphql-api",
  "productVersion": "5.5.4",
  "cpeInfo": {
   "cpeURL": "http://cpe_host:port/wsi/FNCEWS40MTOM/",
   "cpeUser": "uid=admin@ibm.com,cn=users,O=IBM,C=US",
   "repositoryName": "OS1"
   }
  }
 }
}

W przypadku interfejsu API jest dostępny podręcznik programisty. Więcej informacji na ten temat zawiera podręcznik Content Services GraphQL API Developer Guide w dokumentacji produktu IBM® FileNet® P8 Platform .

Korzystanie z elementów webhook

Interfejs API Content Services GraphQL obsługuje elementy webhook. Elementy webhook to zdefiniowane przez użytkownika wywołania zwrotne HTTP realizowane przy użyciu żądań HTTP POST. Umożliwiają one Content Platform Engine udostępnianie informacji w czasie bliskim rzeczywistym innym zainteresowanym aplikacjom lub usługom.

Wywołania zwrotne mogą być wyzwalane przez zdarzenia w Content Platform Engine, takie jak sprawdzanie w dokumencie do repozytorium lub aktualizowanie właściwości w obiekcie Content Platform Engine . Następnie silnik treści kieruje żądanie HTTP POST na adres URL skonfigurowany elementu webhook.

Więcej informacji na temat haków WWW zdarzeń można znaleźć w sekcji Content Platform Engine event webhaoks i Content event webhook examples(Przykłady haków WWW produktu Content Platform).