Angepasste Anwendungen mit der API erstellen

Verwenden Sie die Discovery-API, um eine angepasste Anwendung oder Komponente zu erstellen, die Ihre Daten durchsucht.

API-Versionierung des Service

API-Anforderungen benötigen einen Versionsparameter, der ein Datum im Format version=YYYY-MM-DD angibt. Wenn eine abwärtskompatible API-Änderung auftritt, wird eine neue untergeordnete Version der API freigegeben.

Senden Sie den Versionsparameter mit jeder API-Anforderung. Der Service verwendet die API-Version für das von Ihnen angegebene Datum oder die Version, die vor diesem Datum zuletzt freigegeben wurde. Verwenden Sie nicht das aktuelle Datum als Standardwert. Geben Sie stattdessen ein Datum für eine Version an, die mit Ihrer App kompatibel ist, und ändern Sie das Datum erst dann, wenn Ihre App zur Verwendung einer späteren Version bereit ist.

Die aktuelle Version lautet 2023-03-31.

Projekt-ID abrufen IBM Cloud

Diese Informationen gelten nur für IBM Cloud.

Um die API zu verwenden, müssen Sie die URL in Ihren Anfragen verwenden. Viele API-Methoden erfordern die Projekt-ID.

  1. Erweitern Sie in der IBM Cloud-Ressourcenliste AI/Machine Learningund suchen Sie dann die Serviceseite für Ihre Discovery-Serviceinstanz.

  2. Kopieren Sie im Abschnitt Berechtigungsnachweise die URL. Sie geben diesen Wert als {url} in Ihren API-Anforderungen an.

  3. Kopieren Sie auf dieser Seite den API-Schlüssel. Sie geben diesen Wert als {apikey} an.

  4. Öffnen Sie Ihr Projekt in Discoveryund rufen Sie dann die Seite Integration und Bereitstellung > API-Informationen auf.

  5. Kopieren Sie die Projekt-ID. Sie geben diesen Wert als {project_id} an.

    Wenn Sie ein Content-Mining-Projekt verwenden, bleiben Sie auf der Seite Link teilen. Kopieren Sie aus dem Feld location des Web-Browsers die URL, die mit /projects beginnt. Zum Beispiel projects/a8ce5fed-7f33-4405-aa4b-88ffba322712/deploy/beta. Die nach dem Segment /projects/ der URL angegebene ID ist Ihre Projekt-ID.

  6. Erstellen Sie eine Anfrage an URL, indem Sie die kopierten IDs verwenden.

    Die folgende Anforderung listet beispielsweise die Sammlungen im Projekt auf:

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

Zum Abrufen der {collection_id} können Sie die API-Methode List collections verwenden. Alternativ können Sie die Objektgruppe in der Benutzerschnittstelle des Produkts öffnen und die Objektgruppen-ID, die nach dem Segment /collections/ der Seite URLangezeigt wird, aus dem Positionsfeld des Web-Browsers kopieren.

Verwendung der API IBM Cloud Pak for DataIBM Software Hub

Diese Informationen gelten nur für Discovery for Cloud Pak for Data.

Um die API zu verwenden, müssen Sie die URL in Ihren Anfragen verwenden.

  1. Erweitern Sie im Hauptmenü des Web-Clients "Services " und klicken Sie dann auf "Instanzen ".

  2. Suchen Sie Ihre Instanz und klicken Sie darauf, um die zugehörige Zusammenfassungsseite zu öffnen.

  3. Blättern Sie zum Abschnitt Zugriffsinformationen der Seite und kopieren Sie dann die URL. Sie geben diesen Wert als {url} an.

  4. Kopieren Sie auch das Trägertoken. Dieses Token müssen Sie beim Ausführen eines API-Aufrufs übergeben.

  5. Rufen Sie in der gestarteten Anwendungsinstanz die Seite Integrieren und Implementieren > API-Informationen auf.

  6. Kopieren Sie die Projekt-ID. Sie geben diesen Wert als {project_id} an.

    Wenn Sie ein Content-Mining-Projekt verwenden, bleiben Sie auf der Seite Link teilen. Kopieren Sie aus dem Feld location des Web-Browsers die URL, die mit /projects beginnt. Zum Beispiel projects/a8ce5fed-7f33-4405-aa4b-88ffba322712/deploy/beta. Die nach dem Segment /projects/ der URL angegebene ID ist Ihre Projekt-ID.

  7. Erstellen Sie eine Anfrage an URL, indem Sie die kopierten IDs verwenden.

    Die folgende Anforderung listet beispielsweise die Sammlungen im Projekt auf:

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

Das Trägertoken, das für einen Administrator generiert wird, kann unabhängig von den Zugriffseinstellungen, die für die Instanz konfiguriert sind, auf jede Instanz zugreifen.

Der Träger-Token läuft nach 12 Stunden ab. Weitere Informationen zum Anpassen der Länge einer Sitzung finden Sie unter Zeitlimit für inaktive Sitzungen festlegen.

Nächste Schritte

Ein Entwickler kann die folgenden Erweiterungen vornehmen: