Classes de extensões de API incompatíveis

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 4 min. de leitura

    • A aplicação da Store Modelos de classe de IC do CMDB adiciona ou atualiza classes para APIs incompatíveis (interface de programação de aplicações).

    O app Modelos de classe de IC do CMDB adiciona modelos de classe que estendem a hierarquia de classes CMDB, incluindo descrições de classe, regras de identificação, entradas de identificador e, se aplicável, relacionamentos dependentes. Você pode usar as classes adicionadas como qualquer outra classe CMDB. Aplicações como Padrões de descoberta e mapeamento de serviços podem usar as extensões de classe para preencher ICs e descobrir tecnologias e software.

    Solicitar aplicativos na Store

    Acesse o site ServiceNow Store para ver todos os aplicativos disponíveis e obter informações sobre como enviar solicitações para a loja. Para obter informações sobre notas de versão cumulativa para todos os aplicativos liberados, consulte as ServiceNow Store notas de versão do histórico de versão.

    APIs incompatíveis

    Os endpoints de API que não estão estruturados o suficiente para preencher as classes de API [cmdb_ci_api] e Componente de API [cmdb_ci_api_component], em vez disso, preenchem a classe Endpoint de API incompatível [cmdb_ci_unmatched_api_endpoint]. APIs incompatíveis são normalmente usadas por integrações como scanners de segurança ou ferramentas de observação.

    Classes

    Esta seção lista as classes que a aplicação da loja Modelos de classe de IC do CMDB adiciona ou atualiza.

    Modelos de classe de IC do CMDB: a versão 1.49.0 adiciona a seguinte classe para endpoints de API incompatíveis. Para obter a lista de classes no sistema base, incluindo classes que esta aplicação pode estender, consulte Descrições das tabelas do CMDB.

    Classe Estende Descrição
    Endpoint de API incompatível

    [cmdb_ci_unmatched_api_endpoint]

    		 Item de Configuração

    [cmdb_ci]

    		 APIs com endpoints não estruturados que não podem preencher cmdb_ci_api ou cmdb_ci_api_component.

    Atributos de classe

    Modelos de classe de IC do CMDB: a versão 1.49.0 adiciona os seguintes atributos à classe Endpoint de API incompatível [cmdb_ci_unmatched_api_endpoint].

    Tabela 1. Endpoint de API incompatível [cmdb_ci_unmatched_api_endpoint]
    Atributo Tipo de dados Descrição
    Método Cadeia de caracteres Tipos de protocolo back-end da API. Exemplos:
    • Lambda
    • HTTP
    • Logic App
    Protocolo Cadeia de caracteres Protocolo de comunicação. Por exemplo: HTTP, HTTPS.
    URL Cadeia de caracteres (1024) URL do recurso que está sendo chamado.
    ID Cadeia de caracteres (1024) Identificador exclusivo do sistema de origem.
    Voltado para a internet Booliano Booliano que indica se o componente pode ser acessado através de uma rede de internet pública. Especifique 1 ou "true" (verdadeiro) se o componente for acessível.
    Autorização Cadeia de caracteres Tipo de autorização ou método de autenticação. Exemplo:
    • Básico
    • Chave
    • Oauth
    • Nenhum(a)
    Solicitar tipos de dados Cadeia de caracteres (255) Lista de tipos de dados na solicitação. Exemplos:
    • Cc
    • E-mail
    • Endereço
    Tipos de dados de resposta Cadeia de caracteres (255) Lista de tipos de dados na resposta. Exemplos:
    • Cc
    • E-mail
    • Endereço

    Estruturas de relacionamentos de chave

    A classe do CMDB "Endpoint de API incompatível" [cmdb_ci_unmatched_api_endpoint] e a tabela não pertencente ao CMDB "Endpoint de API descoberto" [api_endpoint_discovered] se destinam a cenários em que dados de API não estruturados são ingeridos e precisam ser processados para além das capacidades do IntegrationHub-ETL.

    A tabela Endpoint de API descoberto [api_endpoint_discovered] pode ser uma tabela de preparação para dados brutos das classes API [cmdb_ci_api] e Componente de API [cmdb_ci_api_component]. Os dados de API que não vêm de uma fonte de dados bem estruturada ou não podem ter regras de identificação padrão aplicadas podem preencher primeiro a tabela Endpoint de API descoberto [api_endpoint_discovered]. Você pode usar uma integração definida pelo cliente para garantir que dados bem formados que correspondam aos requisitos de qualidade e condição da API [cmdb_ci_api] e do Componente de API [cmdb_ci_api_component] preencham a tabela mais apropriada.

    Nos casos em que os dados não possam ser analisados corretamente ou estejam estruturados de forma inesperada, você pode usar uma integração definida pelo cliente para preencher a tabela Endpoint de API incompatível [cmdb_ci_unmatched_api_endpoint].

    Os dados que preenchem a tabela de Endpoint de API descoberto [api_endpoint_discovered] são limpos a cada 30 dias.

    Tabela 2. Endpoint da API descoberto [api_endpoint_discovered]
    Atributo Tipo de dados Descrição
    Nome Cadeia de caracteres (100) Nome do endpoint da API.
    Método Cadeia de caracteres Métodos de REST API. Exemplos:
    • GET
    • POST
    • DELETE
    URL Cadeia de caracteres (1024) URL do recurso que está sendo chamado.
    Tipo Lista de seleção Tipo de API. Você pode especificar:
    • REST
    • SOAP
    • HTTP
    • gRPC
    • GraphQL
    • Websocket
    Autorização Cadeia de caracteres Tipo de autorização ou método de autenticação. Exemplo:
    • Básico
    • Chave
    • OAuth
    • Nenhum
    Voltado para a internet Booliano Booliano que indica se o componente pode ser acessado através de uma rede de internet pública. Especifique 1 ou "true" (verdadeiro) se o componente for acessível.
    Solicitar Datatypes Cadeia de caracteres (255) Lista de tipos de dados na solicitação. Exemplos:
    • Cc
    • E-mail
    • Endereço
    Resposta de Datatypes Cadeia de caracteres (255) Lista de tipos de dados na resposta. Exemplos:
    • Cc
    • E-mail
    • Endereço
    Cabeçalhos Cadeia de caracteres (255) Lista de nomes de cabeçalho separados por vírgulas.
    Item de Configuração Referência Referência a um IC compatível com o CMDB (Componente de API ou Endpoint de API incompatível).

    Tabelas não CMDB relacionadas

    A classe de extensão de API incompatível usa a tabela não pertencente ao CMDB Implementação de API [api_deployment] como lista relacionada:

    Tabela 3. Implementação da API [api_deployment]
    Atributo Tipo de dados Descrição
    Nome Cadeia de caracteres (100) Nome da implementação da API.
    API Referência Referência à API implementada (cmdb_ci_api).
    Endpoint de API incompatível Referência Referência ao endpoint de API incompatível se a API não corresponder a uma API existente (cmdb_ci_unmatched_api_endpoint).
    Item de configuração Referência Referência ao Item de configuração. Se você souber em qual IC a API foi implantada, isso normalmente é especificado manualmente como uma referência.