Classes de extensão de APIs

  • Versão de lançamento: Zurich
  • Atualizado 7 de ago. de 2025
  • 11 min. de leitura

    • . Modelos de classe de IC do CMDB ServiceNow Store O app adiciona ou atualiza classes para APIs (interface de programação de aplicações).

    . Modelos de classe de IC do CMDB o app adiciona modelos de classe que estendem o. CMDB hierarquia de classe, 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 CMDB classe. Aplicações como Padrões de descoberta e mapeamento de serviços Pode usar as extensões de classe para preencher ICs e descobrir tecnologias e software.

    Você encontrará notas de versão completas para todos Modelos de classe de IC do CMDB versões em: https://www.servicenow.com/docs/bundle/store-release-notes/page/release-notes/store/it-operations-management/store-rn-itom-cmdb-class-models.html?emcs_t=S2h8ZW1haWx8Ym9hcmRfc3Vic2NyaXB0aW9ufE1FMlVTSFREVDc3S0hTfDMzNDcxMjV8U1VCU0NSSVBUSU9OU3xoSw

    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

    As APIs são um conjunto de definições e protocolos que permitem que programas de computador se comuniquem entre si, permitindo que você crie ou integre softwares de aplicação. Além disso, APIs normalmente usam tecnologia baseada na web para se comunicarem com outras APIs. E geralmente são usadas para executar trabalhos ou tarefas de forma programática ou para exibir, importar, exportar, excluir ou modificar dados.

    As classes adicionadas nesta versão estendem o. CMDB Modelo de dados e fornecem uma base para a representação de classes de IC de API. Você pode usar esta base para fazer o seguinte:
    • Obter maior visibilidade de suas APIs.
    • Identificar problemas de segurança e de vulnerabilidade associados a um endpoint de API.

    Classes

    Esta seção lista as classes que o Modelos de classe de IC do CMDB o app da store adiciona ou atualiza. Para obter detalhes adicionais, consulte artigo da comunidade intitulado "Novo modelo de dados no CMDB para APIs" .

    Modelos de classe de IC do CMDB: As seguintes classes de API estão disponíveis. Para obter a lista de classes em sistema base, incluindo classes que este app pode estender, consulte Descrições das tabelas do CMDB.

    Classe Estende Descrição
    API

    [cmdb_ci_api]

    		 Item de Configuração

    [cmdb_ci]

    		 APIs que permitem que dois programas de computador se comuniquem, normalmente usando tecnologias baseadas na web. Exemplo: ChatAPI (https://[apiID].execute-api.use-east-2.amazonaws.com).
    Componente de API

    [cmdb_ci_api_component]

    		 Item de configuração

    [cmdb_ci]

    		 Objetos reutilizáveis relacionados à sua definição de API que facilitam a funcionalidade ou a troca de dados. Lista relacionada Cabeçalhos de API. Exemplo: GET https://[instance].service-now.com/api/now/table/{tablename}.
    API front-end

    [cmdb_ci_api_frontend]

    		 Componente de API

    [cmdb_ci_api_component]

    		 A parte de uma API a partir da qual um cliente ou usuário interage ou faz solicitações. Exemplo: GET https://[apiID].execute-api.us-east-2.amazonaws.com/{proxy+}.
    API back-end

    [cmdb_ci_api_backend]

    		 Componente de API

    [cmdb_ci_api_component]

    		 A parte de uma API que atende às solicitações interagindo com serviços de back-end, como servidores. Exemplo: Lambda:Chat-API-Proxy.
    Gateways da API

    [cmdb_ci_api_gateway]

    		 Aplicação

    [cmdb_ci_appl]

    		 Infraestrutura de API que centraliza as solicitações de API do cliente e gerencia processos e serviços de back-end. Exemplo: gateway Kong.
    API gerenciada

    [cmdb_ci_managed_api]

    		 Item de Configuração

    [cmdb_ci_api]

    		 API descoberta a partir de um gateway ou serviço de gerenciamento. Você pode impor uma dependência em um gateway para APIs nesta classe.

    Atributos de classe

    Modelos de classe de IC do CMDB: A versão 1.49.0 adiciona os seguintes atributos às respectivas classes.

    Tabela 1. API [cmdb_ci_api]
    Atributo Tipo de dados Descrição
    URL base Cadeia de caracteres (1024) Endereço base do qual todos os componentes da API se estendem.
    ID Cadeia de caracteres (1024) Identificador exclusivo do sistema de origem.
    Tipo Lista de seleção Tipo de API. Você pode especificar:
    • REST
    • SOAP
    • HTTP
    • gRPC
    • GraphQL
    • Websocket
    Versão Numérico Versão da API.
    Localização de especificação URL URL para o local da especificação da API. Exemplo: definição de especificação do OpenAPI.
    Localização da especificação técnica Cadeia de caracteres Local do repositório de especificação técnica para uma API. Repositório do GitHub que contém o código da API implantado.
    Localização da especificação de design Cadeia de caracteres URL para o local do design ou da documentação da API. Exemplo: URL de especificação de design da API SwaggerHub.
    A classe API [cmdb_ci_api] oferece suporte ao mapeamento de marcadores e rótulos para a tabela Valor de chave [cmdb_key_value] para habilitar o armazenamento de chave-valor para metadados de API.
    Tabela 2. Componente de API [cmdb_ci_api_component]
    Atributo Tipo de dados Descrição
    Método Cadeia de caracteres Métodos de REST API. Exemplos:
    • GET
    • POST
    • DELETE
    Protocolo Cadeia de caracteres Protocolo de comunicação. Por exemplo: HTTP, HTTPS.
    Host Cadeia de caracteres (100) Sistema que hospeda a API.
    Caminho Cadeia de caracteres (1024) Rota específica que a API segue.
    Porta Cadeia de caracteres Porta de comunicação. Exemplo: 80, 443 e assim por diante.
    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
    • Nenhuma
    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
    A classe Componente de API [cmdb_ci_api_component] oferece suporte ao mapeamento de marcadores e rótulos para a tabela Valor de chave [cmdb_key_value] para habilitar o armazenamento de chave-valor para metadados de componente de API.
    Tabela 3. API front-end [cmdb_ci_api_frontend]
    Atributo Tipo de dados Descrição
    ID primária Referência a [cmdb_ci_api_frontend] Referência a um componente de API primário.
    Tabela 4. API back-end [cmdb_ci_api_backend]
    Atributo Tipo de dados Descrição
    Tipo Cadeia de caracteres Tipos de protocolo back-end da API. Exemplos:
    • Lambda
    • HTTP
    • Logic App
    Tabela 5. Gateways da API [cmdb_ci_api_gateway]
    Atributo Tipo de dados Descrição
    ID Cadeia de caracteres (255) Identificador exclusivo do sistema de origem.
    A classe Gateway de API [cmdb_ci_api_gateway] oferece suporte ao mapeamento de marcadores e rótulos para a tabela Valor de chave [cmdb_key_value]. O mapeamento habilita o armazenamento de chave-valor para metadados de gateway de API.
    As seguintes classes de marcador estão disponíveis para gateways de API. Essas classes herdam todos os atributos da classe primária Gateway de API [cmdb_ci_api_gateway].
    • Gateway de API do AnyPoint [cmdb_ci_api_gateway_anypoint] (fornecido pela MuleSoft)
    • Gateway de API do TYK [cmdb_ci_api_gateway_tyk] (fornecido pelo TYK)
    • Boomi API Gateway [cmdb_ci_api_gateway_boomi] (fornecido pelo Boomi)
    As classes de marcador seguem a estrutura de classe existente e não exigem mudanças em Mecanismo de identificação e reconciliação (IRE) regras.
    Nota:
    A classe API gerenciada [cmdb_ci_managed_api] é específica para APIs descobertas de gateways e outros serviços gerenciados e não introduz novos atributos.
    Em gateways de API e portais de desenvolvedor, um pacote de produtos de API é uma coleção de uma ou mais APIs para consumo por desenvolvedores e aplicações. Algumas plataformas usam o termo somente para um produto de API.
    Tabela 6. Pacote de produtos de API [cmdb_ci_api_product_bundle]
    Atributo Tipo de dados Descrição
    ID Cadeia de caracteres (255) Identificador exclusivo do pacote de produtos de API.
    Tipo de aprovação descoberto Cadeia de caracteres Tipo de aprovação de solicitação como descoberta no sistema de origem.
    Tipo de acesso descoberto Cadeia de caracteres Configuração de acesso conforme descoberta no sistema de origem. Por exemplo, público ou interno.
    Data de Criação Data/Hora Data e hora em que o pacote de produtos de API foi descoberto ou registrado inicialmente.
    Data da Última Modificação Data/Hora Data e hora da atualização mais recente do pacote de produtos de API.
    Estado descoberto Cadeia de caracteres Estado atual do pacote de produtos conforme relatado pela origem. Por exemplo, publicado ou descontinuado.
    Para acessar um ou mais pacotes de produtos de API, um desenvolvedor pode se registrar para uma assinatura de consumidor de API em um portal de desenvolvedor. A assinatura é registrada com um ou mais pacotes e fornece uma chave para acesso às APIs nos pacotes.
    Tabela 7. Assinatura do consumidor de API [cmdb_ci_api_consumer_subscription]
    Atributo Tipo de dados Descrição
    Escopo descoberto Cadeia de caracteres Escopo de acesso conforme descoberto no sistema de origem. Por exemplo, Todas as APIs ou APIs específicas.
    Consumidor de API Referência Referência ao registro do consumidor de API. Por exemplo, cmdb_ci_api_consumer.
    ID Cadeia de caracteres (255) Identificador exclusivo da assinatura do consumidor de API.
    Estado descoberto Cadeia de caracteres Status da assinatura como descoberto no sistema de origem. Por exemplo, ativo ou inativo.
    Data de Criação Data/Hora Data e hora em que a assinatura do consumidor da API foi criada no sistema de origem.
    Data da Última Modificação Data/Hora Data e hora da atualização mais recente da assinatura do consumidor da API.

    A classe WebACL [cmdb_ci_web_acl] representa ACLs para CloudFront, REST APIs de gateway de API, balanceadores de carga de aplicações, APIs AppSync GraphQL, grupos de usuários do Cognito, serviços do App Runner, AWS Verified Access e o gateway da aplicação Azure Front Door.

    Estruturas de relacionamentos de chave

    Há vários relacionamentos de chave que precisam ser definidos para as classes Kong e API.

    Tabela 8. Relacionamentos de APIs
    Classe primária Relacionamento Classe secundária Tipo de relacionamento
    API

    [cmdb_ci_api]

    		 Uses::Used by Componente de API

    [cmdb_ci_api_component]

    		 Sugerido
    Gateways da API

    [cmdb_ci_api_gateway]

    		 Provides::Provided By API gerenciada

    [cmdb_ci_managed_api]

    		 Dependente
    API front-end

    [cmdb_ci_api_frontend]

    		 Use End Point To::Use End Point From API back-end

    [cmdb_ci_api_backend]

    		 Sugerido
    API back-end

    [cmdb_ci_api_backend]

    		 Uses::Used by Balanceador de carga Kong

    [cmdb_ci_kong_lb]

    		 Sugerido
    Gateways da API

    [cmdb_ci_api_gateway]

    		 Provides::Provided By Pacote de produtos de API

    [cmdb_ci_api_product_bundle]

    		 Dependente
    Gateways da API

    [cmdb_ci_api_gateway]

    		 Provides::Provided By Assinatura do consumidor de API

    [cmdb_ci_api_consumer_subscription]

    		 Dependente
    Pacote de produtos de API Contains::Contained by API

    [cmdb_ci_api]

    		 Sugerido
    Pacote de produtos de API Used by::Uses Assinatura do consumidor de API

    [cmdb_ci_api_consumer_subscription]

    		 Sugerido

    Tabelas não CMDB relacionadas

    Modelos de classe de IC do CMDB a versão 1.49.0 apresenta as seguintes tabelas não pertencentes ao CMDB como listas relacionadas para as seguintes classes de extensão de API:

    Lista relacionada da API
    Tabela 9. 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.
    Nota:
    A tabela não pertencente ao CMDB de Implementação de API está relacionada às classes API [cmdb_ci_api] e Endpoint de API incompatível [cmdb_ci_unmatched_api_endpoint].
    Lista relacionada de componentes da API
    Tabela 10. Cabeçalho da API [api_header]
    Atributo Tipo de dados Descrição
    Nome Cadeia de caracteres (100) Nome do cabeçalho da API.
    Componente de API Referência Referência ao componente em que o cabeçalho da API está definido (cmdb_ci_api_component).
    Endpoint de API incompatível Referência Referência à API incompatível quando o endpoint não pode ser correspondido a uma API ou componente existente (cmdb_ci_unmatched_endpoint).
    Listas relacionadas aos Gateways da API
    Tabela 11. Consumidor de API [api_consumer]
    Atributo Tipo de dados Descrição
    Nome do usuário Cadeia de caracteres (100)

    Nome do consumidor de API.

    Nota:
    . Consumidor o campo na tabela api_policy é um campo de referência. Para exibir o nome de usuário no Nome de usuário Na lista Políticas de API, você deve definir displayatributo de Nome de usuário . verdadeiro . Se o atributo não estiver definido como verdadeiro , Em seguida, a lista exibirá o SYS ID.
    ID Cadeia de caracteres (255) Identificador exclusivo do sistema de origem.
    ID personalizado Cadeia de caracteres (100) Nome de exibição alternativo do usuário.
    Gateways da API Referência Referência ao gateway em que o consumidor está definido (cmdb_ci_api_gateway).
    Tipo de consumidor da API Lista de seleção Tipo de usuário de API (user_type). Você pode especificar:
    • Interno
    • Externo
    • Desconhecido
    Estado descoberto Cadeia de caracteres Representa o status atual da conta do consumidor da API.
    Provedor Cadeia de caracteres Nome do provedor de gestão de identidade responsável pela autenticação do consumidor da API.
    E-mail Cadeia de caracteres Endereço de e-mail do consumidor da API.
    Data de registro Data/Hora Data em que o consumidor se registrou na plataforma de fornecimento.
    Tabela 12. Acesso do consumidor da API [api_consumer_access]
    Atributo Tipo de dados Descrição
    Consumidor de API Referência Referência ao registro do consumidor de API. Por exemplo, cmdb_ci_api_consumer.
    API Referência Referência à API [cmdb_ci_api] à qual o consumidor está solicitando acesso.
    Método de autenticação Cadeia de caracteres Método de autenticação usado pelo consumidor da API para acessar a API. Por exemplo, chave de API ou OAuth.
    Estado Escolha Indica se o acesso está ativo ou inativo no momento.
    Último uso Data/Hora Última data e hora em que o consumidor da API acessou a API.
    Válida até Data/Hora Data de expiração do acesso do consumidor à API.
    Tabela 13. Política de API [api_policy]
    Atributo Tipo de dados Descrição
    Nome Cadeia de caracteres (100) Nome da política de API.
    ID Cadeia de caracteres (255) Identificador exclusivo do sistema de origem.
    Front-end Referência Referência ao front-end da API (cmdb_ci_api_frontend).
    API gerenciada Referência Referência à API gerenciada (cmdb_ci_managed_api).
    Consumidor Referência Referência à tabela Consumidor de API (api_consumer) não pertencente ao CMDB.
    Nota:
    Consumidor é um campo de referência. Para exibir api_consumer (Nome de usuário) na lista Políticas de API, você deve definir displayatributo para verdadeiro para Nome de usuário campo na tabela api_consumer. Se o atributo não estiver definido como verdadeiro , Em seguida, a lista exibirá o SYS ID.
    Protocolos Cadeia de caracteres Matriz de protocolos aos quais esta política de API pode ser aplicada.
    Ativo Booliano Determina se esta tabela não pertencente ao CMDB é considerada ativa ou inativa.
    Gateways da API Referência Referência ao gateway em que o consumidor está definido (cmdb_ci_api_gateway).