Classes d’extension d’API

  • Rversion finale: Washingtondc
  • Mis à jour 1 févr. 2024
  • 6 minutes de lecture

    • L’application de stockage CMDB CI Class Models ajoute ou met à jour des classes pour les API (interface de programmation d’applications).

    L’application ajoute des modèles de classe qui étendent la hiérarchie des classes CMDB, y compris des descriptions de classe, des règles d’identification, des entrées d’identificateur et des relations dépendantes (le cas échéant). Vous pouvez utiliser les classes ajoutées comme n’importe quelle autre classe CMDB. Des applications telles que Patrons de détection et de mappage des services peuvent utiliser ces extensions de classe pour renseigner les CI et détecter diverses technologies et 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 une technologie basée sur le Web pour communiquer avec d’autres API. Les API sont généralement utilisées pour effectuer 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 modèle de données et fournissent une base pour la représentation des classes CI d’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 stockage CMDB CI Class Models ajoute ou met à jour.

    CMDB CI Class Models : la version 1.49.0 ajoute les classes suivantes pour l’API. Pour obtenir la liste des classes CMDB dans un système de base, y compris celles que cette application de stockage est susceptible d’étendre, reportez-vous à Descriptions des tables CMDB.

    Classe Extensions Description
    API

    [cmdb_ci_api]

    		 ID d'élément de configuration

    [cmdb_ci]

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

    [cmdb_ci_api_component]

    		 ID d'élément de configuration

    [cmdb_ci]

    		 Objets réutilisables associés à votre définition d’API qui facilitent la fonctionnalité ou l’échange de données. Exemple : GET https://[instance].service-now.com/api/now/table/{tablename}.
    Frontal d’API

    [cmdb_ci_api_frontend]

    		 Composant d’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 d’API

    [cmdb_ci_api_component]

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

    [cmdb_ci_api_gateway]

    		 Application

    [cmdb_ci_appl]

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

    [cmdb_ci_managed_api]

    		 ID d'é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

    CMDB CI Class Models : 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 d’API sont étendus.
    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 (en anglais seulement)
    • GraphQL
    • Websocket
    Version Numérique Version de l'API.
    Emplacement de spécification URL URL vers l’emplacement de la spécification d’API. Exemple : définition de spécification OpenAPI.
    Tableau 2. Composant d’API [cmdb_ci_api_component]
    Attribut Type de données Description
    Méthode Chaîne Méthodes de REST API. 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 Chaîne (1024) Itinéraire spécifique suivi par 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 Booléen qui indique si le composant est accessible à partir de l’Internet public. Spécifiez 1 ou « true » si le composant est accessible.
    Autorisation Chaîne Type d’autorisation ou de méthode d’authentification. Exemple :
    • Élémentaire
    • Clé
    • OAuth
    • Néant
    Types de données de demande Chaîne (255) Liste des types de données dans la demande. Exemples :
    • Cc
    • E-mail
    • Adresse
    Types de données de réponse Chaîne (255) Liste des types de données dans la réponse. Exemples :
    • Cc
    • E-mail
    • Adresse
    Tableau 3. Frontal d’API [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. Back-end de l’API [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 d’API [cmdb_ci_api_gateway]
    Attribut Type de données Description
    ID Chaîne (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 des passerelles et d’autres services gérés, et n’introduit pas de nouveaux attributs pour le moment.

    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
    Classes parents Relation Classe enfant Type de relation
    API

    [cmdb_ci_api]

    		 Uses::Used by Composant d’API

    [cmdb_ci_api_component]

    		 Suggéré
    Passerelle d’API

    [cmdb_ci_api_gateway]

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

    [cmdb_ci_managed_api]

    		 Dépendant de
    Frontal d’API

    [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]

    		 Uses ::Used By Équilibreur de charge Kong

    [cmdb_ci_kong_lb]

    		 Suggéré

    Tables non CMDB connexes

    CMDB CI Class Models v 1.49.0 introduit ces tables non CMDB en tant que listes connexes pour les classes d’extension d’API suivantes :

    Liste connexe API
    Tableau 7. Déploiement d’API [api_deployment]
    Attribut Type de données Description
    Nom Chaîne (100) Nom du déploiement d’API.
    API Référence Référence à l’API déployée (cmdb_ci_api).
    Point de terminaison d’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).
    ID d'élément de configuration Référence Référence à l’élément de configuration. Cette option est généralement spécifiée manuellement comme référence, si vous savez sur 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 Composant d’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 de l’API.
    Composant d’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 d’API sans correspondance Référence Référence à l’API sans correspondance lorsque le point de terminaison ne peut pas être mis en correspondance avec une API ou un composant existant (cmdb_ci_unmatched_endpoint).
    Listes connexes Passerelle d’API
    Tableau 9. Consommateur d’API [api_consumer]
    Attribut Type de données Description
    Nom d'utilisateur Chaîne (100) Nom du consommateur d’API.
    ID Chaîne (255) Identificateur unique du système source.
    ID personnalisé Chaîne (100) Autre nom d’affichage de l’utilisateur.
    Passerelle d’API Référence Référence à la passerelle où le consommateur est défini (cmdb_ci_api_gateway).
    Tableau 10. Politique API [api_policy]
    Attribut Type de données Description
    Nom Chaîne (100) Nom de la politique d’API.
    ID Chaîne (255) Identificateur unique du système source.
    Front-end Référence Référence à l’API front-end (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).
    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 d’API Référence Référence à la passerelle où le consommateur est défini (cmdb_ci_api_gateway).