Classes d’extension d’API

  • Rversion finale: Australia
  • Mis à jour 12 mars 2026
  • 10 minutes de lecture

    • L’application Modèles de classe CI CMDB ServiceNow Store ajoute ou met à jour des classes pour les API (interface de programmation d’application).

    Modèles de classe CI CMDB est une application qui ajoute des ServiceNow Store modèles de classe qui étendent la hiérarchie des CMDB classes. Les classes nouvelles ou mises à jour comprennent des descriptions de classe, des règles d’identification, des entrées d’identificateur et, le cas échéant, des relations dépendantes. Vous pouvez utiliser les classes ajoutées comme n’importe quelle autre CMDB classe. Les applications telles que peuvent Schémas de découverte et de mappage des services utiliser les extensions de classe pour renseigner les CI et découvrir des technologies et des logiciels.

    Voir les notes de version complètes pour tout Modèles de classe CI CMDB.

    Demander des applications dans l'App Store

    Visitez le ServiceNow Store pour afficher toutes les applications disponibles et pour obtenir des informations sur la soumission de demandes à la boutique. Pour obtenir des informations sur les notes de publication cumulatives pour toutes les applications publiées, consultez les ServiceNow Store notes de publication relatives à l'historique des versions.

    API

    Les API sont un ensemble de définitions et de protocoles qui permettent aux programmes informatiques de communiquer entre eux, ce qui vous permet de créer ou d’intégrer des logiciels d’application. Les API utilisent généralement la technologie Web pour communiquer avec d’autres API. Les API sont généralement utilisées pour effectuer des tâches ou des tâches par programmation, ou pour afficher, importer, exporter, supprimer ou modifier des données.

    Les classes ajoutées dans cette version étendent le CMDB modèle de données et fournissent une base pour la représentation des classes CI API. Vous pouvez utiliser cette base pour effectuer les opérations suivantes :
    • Bénéficiez d’une meilleure visibilité sur vos API.
    • Identifiez les problèmes de sécurité et les vulnérabilités associés à un point de terminaison d’API.

    Classes

    Cette section répertorie les classes que l’application Modèles de classe CI CMDB ajoute ou met à jour. Pour plus de détails, voir le Article de la communauté intitulé « Nouveau modèle de données dans CMDB pour les API ».

    Modèles de classe CI CMDB: les classes suivantes pour l’API sont disponibles. Pour obtenir la liste des classes dans le , y compris les système de base classes que cette application peut étendre, reportez-vous à la section Descriptions des tables CMDB.

    Classe Extensions Description
    API

    [cmdb_ci_api]

    		 Élément de configuration

    [cmdb_ci]

    		 API qui permettent à deux programmes informatiques de communiquer entre eux, généralement à l’aide de technologies Web. Exemple : ChatAPI (https://[apiID].execute-api.use-east-2.amazonaws.com).
    Composant de l'API

    [cmdb_ci_api_component]

    		 Élément de configuration

    [cmdb_ci]

    		 Objets réutilisables liés à votre définition d’API qui facilitent la fonctionnalité ou l’échange de données. Liste connexe En-têtes des API. Exemple : GET https://[instance].service-now.com/api/now/table/{tablename}.
    API Front-end

    [cmdb_ci_api_frontend]

    		 Composant de l'API

    [cmdb_ci_api_component]

    		 Partie d’une API à partir de laquelle un client ou un utilisateur interagit ou effectue des demandes. Exemple : GET https://[apiID].execute-api.us-east-2.amazonaws.com/{proxy+}.
    Back-end de l'API

    [cmdb_ci_api_backend]

    		 Composant de l'API

    [cmdb_ci_api_component]

    		 Partie d’une API qui répond aux demandes en interagissant avec des services back-end, tels que des serveurs. Exemple : lambda :chat-api-proxy.
    Passerelle API

    [cmdb_ci_api_gateway]

    		 Application

    [cmdb_ci_appl]

    		 Infrastructure d’API qui centralise les demandes d’API client et gère les processus et services back-end. Exemple : Kong Gateway.
    API gérée

    [cmdb_ci_managed_api]

    		 Élément de configuration

    [cmdb_ci_api]

    		 API détectée à partir d’une passerelle ou d’un service de gestion. Vous pouvez appliquer une dépendance sur une passerelle pour les API de cette classe.

    Attributs de classe

    Modèles de classe CI CMDB: la version 1.49.0 ajoute les attributs suivants aux classes respectives.

    Tableau 1. API [cmdb_ci_api]
    Attribut Type de données Description
    URL de base String (1024) Adresse de base à partir de laquelle tous les composants de l’API s’étendent.
    ID String (1024) Identificateur unique du système source.
    Type Liste Type d’API. Vous pouvez spécifier :
    • REST
    • SOAP
    • HTTP
    • gRPC
    • GraphQL
    • Websocket
    Version Numérique Version de l’API.
    Emplacement de spécification URL URL de l’emplacement de la spécification de l’API. Exemple : définition de spécification OpenAPI.
    Emplacement de spécification technique Chaîne Emplacement du référentiel de spécification technique d’une API. Exemple : GitHub référentiel contenant le code d’API déployé.
    Emplacement de la spécification de conception Chaîne URL de l’emplacement de la conception ou de la documentation de l’API. Exemple : URL de spécification de conception d’API SwaggerHub.
    La classe API [cmdb_ci_api] prend en charge le mappage des balises et étiquettes à la table Valeur de clé [cmdb_key_value] pour activer le stockage clé-valeur des métadonnées API.
    Tableau 2. Composant de l’API [cmdb_ci_api_component]
    Attribut Type de données Description
    Fonction de message REST Chaîne Méthodes API REST. Exemples :
    • GET
    • POST
    • DELETE
    Protocole Chaîne Protocole de communication. Exemple : HTTP, HTTPS.
    Hôte Chaîne (100) Système qui héberge l’API.
    Chemin d'accès String (1024) Itinéraire spécifique suivi par l’API.
    Port Chaîne Port de communication. Exemple : 80, 443, et ainsi de suite.
    URL String (1024) URL de la ressource appelée.
    ID String (1024) Identificateur unique du système source.
    Accessible sur Internet Booléen Valeur booléenne qui indique si le composant est accessible à partir de l’Internet public. Spécifiez 1 ou « vrai » si le composant est accessible.
    Autorisation Chaîne Type de méthode d’autorisation ou d’authentification. Exemple :
    • Élémentaire
    • Clé
    • OAuth
    • Aucun
    Types de données de la demande String (255) Liste des types de données dans la demande. Exemples :
    • Cc
    • E-mail
    • Adresse
    Types de données de réponse String (255) Liste des types de données dans la réponse. Exemples :
    • Cc
    • E-mail
    • Adresse
    La classe de composant d’API [cmdb_ci_api_component] prend en charge le mappage des balises et étiquettes à la table Valeur de clé [cmdb_key_value] afin d’activer le stockage clé-valeur pour les métadonnées des composants de l’API.
    Tableau 3. API Front-end [cmdb_ci_api_frontend]
    Attribut Type de données Description
    ID parent Référence à [cmdb_ci_api_frontend] Référence à un composant d’API parent.
    Tableau 4. API back-end [cmdb_ci_api_backend]
    Attribut Type de données Description
    Type Chaîne Types de protocoles back-end de l’API. Exemples :
    • Lambda
    • HTTP
    • Application logique
    Tableau 5. Passerelle API [cmdb_ci_api_gateway]
    Attribut Type de données Description
    ID String (255) Identificateur unique du système source.
    La classe API Gateway [cmdb_ci_api_gateway] prend en charge le mappage des balises et étiquettes à la table Valeur de clé [cmdb_key_value]. Le mappage permet le stockage clé-valeur des métadonnées de passerelle API.
    Les classes de marqueurs suivantes sont disponibles pour les passerelles API. Ces classes héritent de tous les attributs de la classe parent API Gateway [cmdb_ci_api_gateway].
    • Passerelle API Anypoint [cmdb_ci_api_gateway_anypoint] (fourni par MuleSoft)
    • Passerelle API Tyk [cmdb_ci_api_gateway_tyk] (fourni par Tyk)
    • Passerelle API Boomi [cmdb_ci_api_gateway_boomi] (fourni par Boomi)
    Les classes de marqueurs suivent la structure de classe existante et ne nécessitent pas de modification des Moteur d'identification et réconciliation (IRE) règles.
    Remarque :
    La classe Managed API [cmdb_ci_managed_api] est spécifique aux API détectées à partir de passerelles et d’autres services gérés, et n’introduit pas de nouveaux attributs.
    Dans les passerelles API et les portails développeurs, un groupe de produits API est une collection d’une ou de plusieurs API destinées à être consommées par les développeurs et les applications. Certaines plateformes utilisent le terme pour un produit API seul.
    Tableau 6. Groupe de produits API [cmdb_ci_api_product_bundle]
    Attribut Type de données Description
    ID String (255) Identificateur unique du groupe de produits API.
    Type d'approbation détecté Chaîne Type d’approbation de demande telle que détectée à partir du système source.
    Type d'accès détecté Chaîne Configuration de l’accès telle que détectée à partir du système source. Par exemple, public ou interne.
    Date de création Date/Heure Date et heure auxquelles le groupe de produits API a été initialement détecté ou enregistré.
    Dernière date modifiée Date/Heure Date et heure de la mise à jour la plus récente du groupe de produits API.
    État détecté Chaîne État actuel du groupe de produits tel que rapporté par la source. Par exemple, publié ou déconseillé.
    Pour accéder à un ou plusieurs groupes de produits API, un développeur peut s’inscrire à un abonnement de consommateur d’API sur un portail des développeurs. L’abonnement s’enregistre avec un ou plusieurs lots et fournit une clé pour accéder aux API des groupes.
    Tableau 7. Abonnement du consommateur d’API [cmdb_ci_api_consumer_subscription]
    Attribut Type de données Description
    Champ d'application détecté Chaîne Périmètre d’accès tel que détecté à partir du système source. Par exemple, toutes les API ou des API spécifiques.
    Consommateur d'API Référence Référence à l'enregistrement du consommateur de l'API. Par exemple, cmdb_ci_api_consumer.
    ID String (255) Identificateur unique de l'abonnement du consommateur de l'API.
    État détecté Chaîne État de l’abonnement tel que détecté à partir du système source. Par exemple, actif ou inactif.
    Date de création Date/Heure Date et heure auxquelles l’abonnement du consommateur de l’API a été créé dans le système source.
    Dernière date modifiée Date/Heure Date et heure de la dernière mise à jour de l’abonnement du consommateur d’API.

    La classe WebACL [cmdb_ci_web_acl] représente les ACL pour CloudFront, les API REST de passerelle API, les équilibreurs de charge d’applications, les API AppSync GraphQL, les pools d’utilisateurs Cognito, les services App Runner, AWS l’accès vérifié et la passerelle d’application Azure Front Door.

    Structures de relations clés

    Un certain nombre de relations clés doivent être définies pour les classes API et Kong.

    Tableau 8. Relations d’API
    Classes parents Relation Classe enfant Type de relation
    API

    [cmdb_ci_api]

    		 Utilisations ::Utilisé par Composant de l'API

    [cmdb_ci_api_component]

    		 Suggéré
    Passerelle API

    [cmdb_ci_api_gateway]

    		 Fournit ::P fourni par API gérée

    [cmdb_ci_managed_api]

    		 Dépendant(e) de
    API Front-end

    [cmdb_ci_api_frontend]

    		 Utiliser le point de terminaison VERS ::Utiliser le point de terminaison depuis Back-end de l'API

    [cmdb_ci_api_backend]

    		 Suggéré
    Back-end de l'API

    [cmdb_ci_api_backend]

    		 Utilisations ::Utilisé par Équilibreur de charge Kong

    [cmdb_ci_kong_lb]

    		 Suggéré
    Passerelle API

    [cmdb_ci_api_gateway]

    		 Fournit ::P fourni par Lot de produits d'API

    [cmdb_ci_api_product_bundle]

    		 Dépendant(e) de
    Passerelle API

    [cmdb_ci_api_gateway]

    		 Fournit ::P fourni par Abonnement de consommateur d'API

    [cmdb_ci_api_consumer_subscription]

    		 Dépendant(e) de
    Lot de produits d'API Contient ::Contenu par API

    [cmdb_ci_api]

    		 Suggéré
    Lot de produits d'API Utilisé par ::Utilisations Abonnement de consommateur d'API

    [cmdb_ci_api_consumer_subscription]

    		 Suggéré

    Non-tablesCMDB connexes

    Modèles de classe CI CMDB v 1.49.0 introduit les non-tablesCMDB suivantes en tant que listes connexes pour les classes d’extension d’API suivantes :

    Liste connexe de l’API
    Tableau 9. Déploiement d’API [api_deployment]
    Attribut Type de données Description
    Nom Chaîne (100) Nom du déploiement de l’API.
    API Référence Référence à l’API déployée (cmdb_ci_api).
    Point de terminaison de l'API sans correspondance Référence Référence au point de terminaison de l’API sans correspondance, si l’API ne correspond pas à une API existante (cmdb_ci_unmatched_api_endpoint).
    Élément de configuration Référence Référence à l’élément de configuration. Ceci est généralement spécifié manuellement en tant que référence, si vous savez vers quel CI l’API est déployée.
    Remarque :
    La non-tableCMDB Déploiement d’API se rapporte aux classes API [cmdb_ci_api] et Point de terminaison d’API sans correspondance [cmdb_ci_unmatched_api_endpoint].
    Liste connexe du composant de l’API
    Tableau 10. En-tête de l’API [api_header]
    Attribut Type de données Description
    Nom Chaîne (100) Nom de l’en-tête de l’API.
    Composant de l'API Référence Référence au composant dans lequel l’en-tête d’API est défini (cmdb_ci_api_component).
    Point de terminaison de l'API sans correspondance Référence Référence à l’API lorsqu’il n’est pas possible de mettre en correspondance le point de terminaison avec une API ou un composant existant (cmdb_ci_unmatched_endpoint).
    Listes connexes de passerelle API
    Tableau 11. Consommateur d’API [api_consumer]
    Attribut Type de données Description
    Nom d'utilisateur Chaîne (100)

    Nom du consommateur de l’API.

    Remarque :
    Le champ Consumer (Consommateur ) de la table api_policy est un champ de référence. Pour afficher le nom d’utilisateur dans le champ Nom d’utilisateur de la liste Politiques d’API, vous devez définir l’attribut Nom d’utilisateurdisplay sur vrai. Si l’attribut n’est pas défini sur true, la liste affiche l’ID système à la place.
    ID String (255) Identificateur unique du système source.
    ID personnalisé Chaîne (100) Autre nom d’affichage de l’utilisateur.
    Passerelle API Référence Référence à la passerelle où le consommateur est défini (cmdb_ci_api_gateway).
    Type de consommateur d'API Liste Type d’utilisateur d’API (user_type). Vous pouvez spécifier :
    • Interne
    • Externe
    • Inconnu
    État détecté Chaîne Représente l’état actuel du compte du consommateur de l’API.
    Fournisseur Chaîne Nom du fournisseur de gestion d’identité responsable de l’authentification du consommateur de l’API.
    E-mail Chaîne Adresse e-mail du consommateur de l’API.
    Date d'inscription Date/Heure Date à laquelle le consommateur s'est inscrit sur la plateforme de fourniture.
    Tableau 12. Accès consommateur d’API [api_consumer_access]
    Attribut Type de données Description
    Consommateur d'API Référence Référence à l'enregistrement du consommateur de l'API. Par exemple, cmdb_ci_api_consumer.
    API Référence Référence à l’API [cmdb_ci_api] à laquelle le consommateur demande l’accès.
    Méthode d'authentification Chaîne Méthode d’authentification utilisée par le consommateur de l’API pour accéder à l’API. Par exemple, clé API ou OAuth.
    État Choix Indique si l’accès est actuellement actif ou inactif.
    Dernière utilisation Date/Heure Date et heure auxquelles le consommateur de l’API a accédé à l’API pour la dernière fois.
    Date de fin de validité Date/Heure Date d’expiration de l’accès du consommateur à l’API.
    Tableau 13. Politique d’API [api_policy]
    Attribut Type de données Description
    Nom Chaîne (100) Nom de la politique d’API.
    ID String (255) Identificateur unique du système source.
    Front-end Référence Référence au front-end de l’API (cmdb_ci_api_frontend).
    API gérée Référence Référence à l’API gérée (cmdb_ci_managed_api).
    Consommateur Référence Référence à la non-tableCMDB Consommateur d’API (api_consumer).
    Remarque :
    Consommateur est un champ de référence. Pour afficher le api_consumer (nom d’utilisateur) dans la liste des politiques d’API, vous devez définir l’attribut sur vrai pour le display champ Nom d’utilisateur de la table api_consumer. Si l’attribut n’est pas défini sur true, la liste affiche l’ID système à la place.
    Protocoles Chaîne Tableau de protocoles auxquels cette politique d’API peut s’appliquer.
    Actives Booléen Détermine si cette table secondaireCMDB est considérée comme active ou inactive.
    Passerelle API Référence Référence à la passerelle où le consommateur est défini (cmdb_ci_api_gateway).