Classes d’extension d’API

  • Rversion finale: Yokohama
  • Mis à jour 30 janv. 2025
  • 6 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).

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

    Demander des applications dans l'App Store

    Visitez le site Web ServiceNow Store pour découvrir toutes les applications disponibles et pour obtenir des informations sur la procédure à suivre pour soumettre des demandes à la boutique. Pour obtenir des informations sur les notes de publication cumulatives pour toutes les applications publiées, consultez les ServiceNow Storenotes 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 de l’App Modèles de classe CI CMDB Store ajoute ou met à jour.Pour plus de détails, consultez l’article de la communauté intitulé « Nouveau modèle de données dans CMDB pour les API ».

    Modèles de classe CI CMDB: la version 1.49.0 ajoute les classes suivantes pour l’API. Pour obtenir la liste des classes dans le système de base, y compris les 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 d’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]

    		 Demande

    [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 à 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 Chaîne (1024) Adresse de base à partir de laquelle tous les composants de l’API s’étendent.
    ID Chaîne (1024) Identificateur unique du système source.
    Type Liste de choix Type d’API. Vous pouvez spécifier :
    • REST
    • SOAP
    • HTTP
    • gRPC
    • GraphQL
    • Websocket
    Version Numérique Version de l'API.
    Emplacement de spéc. URL URL vers l’emplacement de la spécification d’API. Exemple : définition de spécification OpenAPI.
    Tableau 2. Composant de l’API [cmdb_ci_api_component]
    Attribut Type de données Description
    Méthode 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 Chaîne (1024) Itinéraire spécifique que suit l’API.
    Port Chaîne Port de communication. Exemple : 80, 443, etc.
    URL Chaîne (1024) URL de la ressource appelée.
    ID Chaîne (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 d’autorisation ou méthode d’authentification. Exemple :
    • Élémentaire
    • Clé
    • OAuth
    • Néant
    Types de données de la demande Ficelle (255) Liste des types de données dans la demande. Exemples :
    • Cc
    • E-mail
    • Adresse
    Types de données de réponse Ficelle (255) Liste des types de données dans la réponse. Exemples :
    • Cc
    • E-mail
    • Adresse
    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 Ficelle (255) Identificateur unique du système source.
    Remarque :
    L’API managée [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 pour l’instant.

    Structures des relations clés

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

    Tableau 6. Relations API
    Classe parente Relation Classe enfant Type de relation
    API

    [cmdb_ci_api]

    		 Uses::Used by 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]

    		 Use End Point To::Use End Point From 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é

    Tables non CMDB connexes

    Modèles de classe CI CMDB La version 1.49.0 introduit ces tables non CMDB en tant que listes connexes pour les classes d’extension d’API suivantes :

    Liste connexe de l’API
    Tableau 7. 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 d’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. Elle est généralement spécifiée manuellement comme référence, si vous savez vers quel CI l’API est déployée.
    Remarque :
    La table non-CMDB de 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 8. En-tête d’API [api_header]
    Attribut Type de données Description
    Nom Chaîne (100) Nom de l’en-tête d’API.
    Composant de l'API Référence Référence au composant dans lequel l’en-tête de l’API est défini (cmdb_ci_api_component).
    Point de terminaison de l'API sans correspondance Référence Référence à l’API lorsque le point de terminaison ne peut pas correspondre à une API ou à un composant existant (cmdb_ci_unmatched_endpoint).
    Listes connexes de passerelle API
    Tableau 9. 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 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 display de nom d’utilisateur sur vrai. Si l’attribut n’est pas défini sur true, la liste affiche l’ID système à la place.
    ID Ficelle (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).
    Tableau 10. Politique d’API [api_policy]
    Attribut Type de données Description
    Nom Chaîne (100) Nom de la politique d’API.
    ID Ficelle (255) Identificateur unique du système source.
    Front-end Référence Référence au front-end d’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 table non CMDB 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.
    Actif Booléen Détermine si cette table non CMDB 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).