Classes de extensão de APIs

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 6 min. de leitura

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

    O app adiciona modelos de classe que estendem a hierarquia de classes do CMDB, incluindo descrições de classe, regras de identificação, entradas de identificador e relacionamentos dependentes, se aplicável. Você pode usar as classes adicionadas como qualquer outra classe base do CMDB. Aplicações como Padrões de descoberta e mapeamento de serviços podem usar essas extensões de classe para preencher ICs e descobrir várias 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

    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 modelo de dados para fornecer 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 a aplicação da Store dos Modelos de classe de IC do CMDB adiciona ou atualiza.

    Modelos de classe de IC do CMDB: a versão 1.49.0 adiciona as seguintes classes para a API. Para obter a lista de classes do CMDB em um sistema de base, incluindo classes que esta aplicação da Store pode estender, confira 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. 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.
    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
    Tabela 3. API de 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.
    Nota:
    A API gerenciada [cmdb_ci_managed_api] é específica para APIs descobertas de gateways e outros serviços gerenciados, e não apresenta novos atributos no momento.

    Estruturas de relacionamentos de chave

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

    Tabela 6. 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

    Tabelas não CMDB relacionadas

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

    Lista relacionada da API
    Tabela 7. 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 8. 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 9. Consumidor de API [api_consumer]
    Atributo Tipo de dados Descrição
    Nome do usuário Cadeia de caracteres (100) Nome do consumidor de API.
    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).
    Tabela 10. 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.
    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).