Creación de aplicaciones personalizadas con la API

Utilice la API Discovery para crear una aplicación o componente personalizado que busque los datos.

Versiones de la API del servicio

Las solicitudes de API requieren un parámetro de versión que adopta una fecha en el formato version=YYYY-MM-DD. Siempre que se produce un cambio de API incompatible con versiones anteriores, se publica una nueva versión menor de la API.

Envíe el parámetro version con cada solicitud de API. El servicio utiliza la versión de la API correspondiente a la fecha que especifique, o la versión más reciente anterior a dicha fecha. No especifique como valor predeterminado la fecha actual. En su lugar, especifique una fecha que coincida con una versión que sea compatible con su app y no la modifique hasta que la app esté lista para una versión posterior.

La versión actual es 2023-03-31.

Obtención del ID de proyecto IBM Cloud

Esta información sólo se aplica a IBM Cloud.

Para utilizar la API, debe construir la URL para utilizarla en sus solicitudes. Muchos de los métodos de API requieren el ID de proyecto.

  1. En la lista de recursos deIBM Cloud, expanda AI/Machine Learningy, a continuación, busque la página de servicio para la instancia de servicio de descubrimiento.

  2. En la sección Credenciales, copie el URL. Este valor se especifica como {url} en las solicitudes de API.

  3. Mientras esté en esta página, copie la clave de API. Usted especifica este valor como el " {apikey} " (valor de referencia de la moneda).

  4. Abra el proyecto en Discoveryy, a continuación, vaya a la página Integrar y desplegar > Información de API.

  5. Copie el ID de proyecto. Usted especifica este valor como el " {project_id} " (valor de referencia de la moneda).

    Si está utilizando un proyecto de Content Mining, permanezca en la página Compartir enlace. En el campo ubicación del navegador web, copie el URL que empieza por /projects. Por ejemplo, projects/a8ce5fed-7f33-4405-aa4b-88ffba322712/deploy/beta. El ID que se especifica después del segmento /projects/ del URL es el ID de proyecto.

  6. Cree una solicitud URL utilizando los ID que ha copiado.

    Por ejemplo, la siguiente solicitud lista las colecciones del proyecto:

    curl -X {request_method} -u "apikey:{apikey}" \
"{url}/v2/projects/{project_id}/collections?version=2019-11-29 -k"

Para obtener el {collection_id}, puede utilizar el método de API Listar colecciones. De forma alternativa, abra la colección en la interfaz de usuario del producto y, a continuación, copie el ID de colección, que se muestra después del segmento /collections/ de la página URL, desde el campo de ubicación del navegador web.

Uso de la API IBM Cloud Pak for DataIBM Software Hub

Esta información sólo se aplica a Discovery for Cloud Pak for Data.

Para utilizar la API, debe construir la URL para utilizarla en sus solicitudes.

  1. En el menú principal del cliente web, expanda Servicios y, a continuación, haga clic en Instancias.

  2. Busque la instancia y, a continuación, púlselo para abrir su página de resumen.

  3. Desplácese a la sección Información de acceso de la página y, a continuación, copie el URL. Este valor se especificará como {url}.

  4. Copie también la señal del portador. Deberá pasar la señal cuando realice una llamada de API.

  5. Desde la instancia de aplicación iniciada, vaya a la página Integrar y desplegar > Información de API de ****.

  6. Copie el ID de proyecto. Deberá especificar este valor como el " {project_id} ".

    Si está utilizando un proyecto de Content Mining, permanezca en la página Compartir enlace. En el campo ubicación del navegador web, copie el URL que empieza por /projects. Por ejemplo, projects/a8ce5fed-7f33-4405-aa4b-88ffba322712/deploy/beta. El ID que se especifica después del segmento /projects/ del URL es el ID de proyecto.

  7. Cree una solicitud URL utilizando los ID que ha copiado.

    Por ejemplo, la siguiente solicitud lista las colecciones del proyecto:

    curl -H "Authorization: Bearer {token}" \
"{url}/v2/projects/{project_id}/collections?version=2019-11-29 -k"

La señal portadora que se genera para un administrador puede acceder a cualquier instancia independientemente de los valores de acceso configurados para la instancia.

El token al portador caduca a las 12 horas. Para obtener más información sobre cómo personalizar la duración de una sesión, consulte Establecimiento del tiempo de espera de sesión desocupada.

Próximos pasos

Un desarrollador puede realizar las mejoras siguientes: