API de Content Services GraphQL

Utilice la API para crear, recuperar, actualizar o suprimir recursos. Esta API es ideal para el desarrollo de aplicaciones web y móviles ya que da soporte a la recuperación de exactamente los datos que se necesitan con una única llamada. De forma predeterminada, esta API se proporciona en la suscripción.

Información General

La API GraphQL de Content Services proporciona un esquema y un sistema de lenguaje de consulta fácil de entender que simplifica el desarrollo de aplicaciones para Content Platform Engine. La definición del esquema de tipos y campos de la API coincide estrechamente con el modelo de objetos de la API Java™ de Content Engine, con las extensiones necesarias y deseables para el consumo natural de los desarrolladores de GraphQL.

La API incluye las operaciones siguientes:
  • Descubrimiento de metadatos
  • Operaciones de documento y carpeta
  • Operaciones de búsqueda
  • Operaciones de examinar
Acceda al punto final de la API utilizando uno de los URL siguientes. Utilice la URL que corresponda a la configuración de su suscripción.
  • https://hostname.automationcloud.ibm.com.com/dba/environment/content-services-graphql/graphql
  • https://fncm-environment-hostname.automationcloud.ibm.com/content-services-graphql/graphql
donde entorno tiene el valor dev para el entorno de desarrollo, test para el entorno de prueba o run para el entorno de producción.
La API tiene un entorno de desarrollo integrado en navegador (GraphiQL) para ayudarle a explorar e interactuar con la API. En función de cómo se haya configurado la suscripción, acceda al entorno de desarrollo integrado utilizando uno de los URL siguientes:
  • https://hostname.automationcloud.ibm.com/dba/environment/content-services-graphql/
  • https://fncm-environment-hostname.automationcloud.ibm.com/content-services-graphql/
Asegúrese de incluir "/" al final del URL.
Nota: El entorno de desarrollo integrado no está disponible en el entorno de producción.

Todas las aplicaciones que utilizan la API GraphQL deben pasar una señal ECM-CS-XSRF-Token en la cabecera y la cookie. Se recomienda que el cliente GraphQL genere la señal, la establezca como cookie en el navegador del cliente y guarde el mismo valor en la sesión de usuario. Cuando llega una solicitud de cliente, el cliente GraphQL valida la cookie ECM-CS-XSRF-Token con respecto al valor guardado. Cuando la solicitud se pasa a Content Services GraphQL, estos valores se encuentran en la cabecera ECM-CS-XSRF-Token y la cookie EM-CS-XSRF-Token.

Prueba de conexión con la API

Después de acceder a la instancia de GraphQL para la API, puede probar la conexión con Content Platform Engine tal como se muestra en el ejemplo siguiente.
{
  _apiInfo(repositoryIdentifier: "OS1") {
    buildDate
    buildNumber
    implementationVersion
    implementationTitle
    productVersion
    cpeInfo {
      cpeURL
      cpeUser
      repositoryName
    }
  }
}
El valor de repositoryIdentifier es el nombre del almacén de objetos de Content Platform Engine (nombre simbólico) o ID (GUID).
Una conexión satisfactoria proporciona una respuesta similar a la del ejemplo siguiente.
{
 "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"
   }
  }
 }
}

Hay una guía del desarrollador disponible para la API. Para obtener más información, consulte la Guía para desarrolladores de API de Content Services GraphQL en la IBM® FileNet® P8 Platform documentación.

Utilización de webhooks

La API Content Services GraphQL soporta webhooks. Los webhooks son devoluciones de llamada HTTP definidas por el usuario hechas con solicitudes HTTP POST. Permiten al Content Platform Engine contenidos proporcionar información casi en tiempo real a otras aplicaciones o servicios interesados.

Las devoluciones de llamada se pueden desencadenar mediante sucesos en Content Platform Engine, como la incorporación de un documento a un repositorio o la actualización de una propiedad en un objeto Content Platform Engine . Content Engine hace entonces una solicitud HTTP POST al URL que está configurado para el webhook.

Para obtener más información sobre los webhooks de eventos, consulte los webhooks de eventos de Content Platform Engine y los ejemplos de webhooks de eventos de contenido.