Creazione di applicazioni personalizzate con l'API

Utilizza l'API Discovery per creare un'applicazione o un componente personalizzato che ricerca i tuoi dati.

Controllo versioni delle API del servizio

Le richieste API richiedono un parametro di versione che prende una data nel formato version=YYYY-MM-DD. Ogni volta che si verifica una modifica dell'API incompatibile con le versioni precedenti, viene rilasciata una nuova versione secondaria dell'API.

Invia il parametro di versione con ogni richiesta API. Il servizio utilizza la versione API per la data che specifichi oppure la versione più recente prima di tale data. Non utilizzare, per impostazione predefinita, la data attuale. Specifica invece una data che corrisponde a una versione compatibile con la tua applicazione e non modificarla finché la tua applicazione non è pronta per una versione successiva.

La versione attuale è 2023-03-31.

Ottenere l'ID del tuo progetto IBM Cloud

Queste informazioni si applicano solo a IBM Cloud.

Per utilizzare l'API, devi creare l' URL da utilizzare nelle tue richieste. Molti dei metodi API richiedono l'ID progetto.

  1. Dall'IBM Cloud, espandi AI/Machine Learninge trova la pagina del servizio per la tua istanza del servizio di rilevamento.

  2. Dalla sezione Credenziali, copia l'URL URL. Specifichi questo valore come {url} nelle tue richieste API.

  3. Mentre sei su questa pagina, copia la chiave API. Specificare questo valore come {apikey}.

  4. Apri il progetto in Discoverye vai alla pagina Integrate and deploy > API Information.

  5. Copiare l'ID progetto. Specificare questo valore come {project_id}.

    Se si utilizza un progetto di Content Mining, rimanere nella pagina Condividi link. Dal campo ubicazione del browser Web, copiare l' URL che inizia con /projects. Ad esempio, projects/a8ce5fed-7f33-4405-aa4b-88ffba322712/deploy/beta. L'ID specificato dopo il segmento /projects/ dell'URL URL è il tuo ID progetto.

  6. Crea una richiesta URL utilizzando gli ID che hai copiato.

    Ad esempio, la seguente richiesta elenca le raccolte nel progetto:

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

Per ottenere {collection_id}, puoi utilizzare il metodo API List collections. In alternativa, aprire la raccolta nell'interfaccia utente del prodotto, quindi copiare l'ID raccolta, visualizzato dopo il segmento /collections/ della pagina URL, dal campo dell'ubicazione del browser Web.

Utilizzo dell'API IBM Cloud Pak for DataIBM Software Hub

Queste informazioni si applicano solo a Discovery for Cloud Pak for Data.

Per utilizzare l'API, devi creare l' URL da utilizzare nelle tue richieste.

  1. Dal menu principale del client web, espandi Servizi, quindi fai clic su Istanze.

  2. Trova la tua istanza e fai clic su di essa per aprirne la pagina di riepilogo.

  3. Scorri fino alla sezione Access information della pagina e copia l' URL. Questo valore sarà specificato come " {url} ".

  4. Copia anche il token di connessione. Dovrai passare il token quando effettui una chiamata API.

  5. Dall'istanza dell'applicazione avviata, vai alla pagina Integra e distribuisci > Informazioni API.

  6. Copiare l'ID progetto. Questo valore sarà specificato come " {project_id} ".

    Se si utilizza un progetto di Content Mining, rimanere nella pagina Condividi link. Dal campo ubicazione del browser Web, copiare l' URL che inizia con /projects. Ad esempio, projects/a8ce5fed-7f33-4405-aa4b-88ffba322712/deploy/beta. L'ID specificato dopo il segmento /projects/ dell'URL URL è il tuo ID progetto.

  7. Crea una richiesta URL utilizzando gli ID che hai copiato.

    Ad esempio, la seguente richiesta elenca le raccolte nel progetto:

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

Il token di connessione generato per un amministratore può accedere a qualsiasi istanza indipendentemente dalle impostazioni di accesso configurate per l'istanza.

Il token di connessione scade dopo 12 ore. Per ulteriori informazioni relative alla personalizzazione della lunghezza di una sessione, consultare Impostazione del timeout di inattività della sessione.

Passi successivi

Uno sviluppatore può apportare i seguenti miglioramenti: