Construindo aplicativos personalizados com a API

Use a API Discovery para construir um aplicativo ou componente personalizado que pesquisa seus dados.

Versão da API de Serviço

As solicitações de API requerem um parâmetro version que use uma data no formato version=YYYY-MM-DD. Sempre que ocorre uma mudança de API incompatível com versões anteriores, uma nova versão secundária da API é liberada

Envie o parâmetro version com cada solicitação de API. O serviço usa a versão da API para a data que você especificar ou a versão mais recente antes dessa data. Não padronize com a data atual. Em vez disso, especifique uma data que corresponda a uma versão que seja compatível com seu aplicativo e não a mude até que o aplicativo esteja pronto para uma versão mais recente.

A versão atual é 2023-03-31.

Obtendo seu ID do projeto IBM Cloud

Essas informações se aplicam a IBM Cloud apenas.

Para usar a API, você deve construir o URL para usar em suas solicitações. Muitos dos métodos da API requerem o ID do projeto.

  1. A partir da lista de Recursos IBM Cloud, expanda AI/Machine Learninge, em seguida, encontre a página de serviço para a sua instância de serviço Discovery.

  2. Na seção Credenciais, copie a URL. Você especifica esse valor como o {url} em seus pedidos de API.

  3. Enquanto você está nesta página, copie a chave API. Você especifica esse valor como {apikey}.

  4. Abra o seu projeto em Discoverye, em seguida, vá até a página Integrar e implementar > Informações da API.

  5. Copie o ID do projeto. Você especifica esse valor como {project_id}.

    Se você estiver usando um projeto de Mineração de Conteúdo, fique na página Compartilhar Link. No campo local do navegador da web, copie a URL começando com /projects. Por exemplo, projects/a8ce5fed-7f33-4405-aa4b-88ffba322712/deploy/beta. O ID especificado após o segmento /projects/ da URL é o seu ID do projeto.

  6. Construa uma solicitação URL usando as IDs que você copiou.

    Por exemplo, a seguinte solicitação lista as coleções no projeto:

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

Para obter o {collection_id}, é possível usar o método da API Listar coleções. Como alternativa, abra a coleção na interface com o usuário do produto e, em seguida copie o ID da coleção, que é exibido após o segmento /collections/ da página URL, no campo de local do navegador da web.

Usando a API IBM Cloud Pak for DataIBM Software Hub

Essas informações se aplicam a Discovery for Cloud Pak for Data apenas.

Para usar a API, você deve construir o URL para usar em suas solicitações.

  1. No menu principal do cliente Web, expanda Services (Serviços ) e clique em Instances (Instâncias ).

  2. Encontre sua instância e, em seguida, clique nele para abrir sua página de resumo.

  3. Role para a seção Informações de acesso da página e, em seguida, copie a URL Você especificará esse valor como a {url}.

  4. Copie o token de acesso também. É necessário transmitir o token ao fazer uma chamada de API.

  5. A partir da instância do aplicativo lançado, vá até a página Integrar e implementar > Informações da API.

  6. Copie o ID do projeto. Você especificará esse valor como {project_id}.

    Se você estiver usando um projeto de Mineração de Conteúdo, fique na página Compartilhar Link. No campo local do navegador da web, copie a URL começando com /projects. Por exemplo, projects/a8ce5fed-7f33-4405-aa4b-88ffba322712/deploy/beta. O ID especificado após o segmento /projects/ da URL é o seu ID do projeto.

  7. Construa uma solicitação URL usando as IDs que você copiou.

    Por exemplo, a seguinte solicitação lista as coleções no projeto:

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

O token do portador que é gerado para um administrador pode acessar qualquer instância independentemente das configurações de acesso configuradas para a instância.

O token de portador expira após 12 horas. Para obter mais informações sobre como personalizar o comprimento de uma sessão, veja Configurando o tempo limite da sessão idle.

Próximas etapas

Um desenvolvedor pode fazer os seguintes aprimoramentos: