Terminologie de base

Interface de programmation d'application, c'est-à-dire une interface qui permet à une application de consommer facilement les fonctionnalités ou les données d'une autre application.

En définissant des points d'entrée stables et simplifiés sur la logique et les données des applications, les API permettent aux développeurs d'accéder facilement à la logique d'application créée par d'autres développeurs et de la réutiliser. Dans le cas des API Web, cette logique et ces données sont exposées sur le réseau. Étant donné que les applications qui consomment des API sont sensibles aux modifications, les API impliquent également un contrat. Le contrat fournit un certain niveau de garantie, selon lequel l'API évolue de manière prévisible au fil du temps.

Apigee fournit des informations sur les API et les bonnes pratiques permettant de les développer et de les utiliser. Pour commencer, consultez le webcast d'API Design ou téléchargez l'e-book sans frais Web API Design: The Missing Link Best Practices for Crafting Interfaces that Developers Love.

Façade sur Edge pour une ou plusieurs API, services HTTP génériques ou applications (telles que Node.js).

Un proxy d'API est mis en œuvre sous la forme d'un ensemble de fichiers de configuration, de règles et de code s'appuyant sur un ensemble de ressources fournies par Apigee Edge. Les proxys d'API peuvent être générés et configurés à l'aide de l'interface utilisateur de gestion Apigee Edge, ou peuvent être mis en œuvre localement dans un éditeur de texte ou un IDE.

Cette façade, fournie par un proxy d'API, dissocie l'API destinée aux développeurs des services de backend, ce qui empêche les développeurs d'apporter des modifications au code, tout en vous permettant d'innover en périphérie sans affecter vos équipes de développement internes. À mesure que les équipes de développement modifient les backends, les développeurs continuent d'appeler la même interface sans subir d'interruption. Apigee vous permet d'exposer plusieurs interfaces à la même API. Vous pouvez ainsi personnaliser la signature d'une API pour répondre simultanément aux besoins de plusieurs groupes de développeurs.

API définies par des adresses réseau et des URI. Une API est composée d'un chemin de base et d'un ensemble de ressources d'API. Chaque proxy d'API définit un chemin de base et, éventuellement, plusieurs chemins de ressource d'API. Vous pouvez considérer une API comme un ensemble d'URI, qui partagent tous un chemin de base commun.

Pour faciliter la gestion de vos API, Apigee étend ces URI bruts à l'aide de noms et de descriptions à afficher. Edge vous permet d'associer des règles et du code à des URI afin d'assurer une gestion et un contrôle précis du comportement de vos API.

Ensemble de ressources d'API (URI) associées à un quota, ou plan de service, publié pour les développeurs d'applications au moment de la conception. Les produits d'API peuvent, à leur tour, être regroupés dans des packages d'API pour la monétisation.

Une clé API est liée à un ou plusieurs produits d'API, ce qui établit une liaison entre une application et le groupe d'URI que l'application est autorisée à utiliser.

Abréviation de application. Le terme app fait référence aux applications mobiles qui consomment des API. Les développeurs mettent en œuvre des applications dans différents langages de programmation, et utilisent diverses technologies et plates-formes. Les développeurs qui souhaitent utiliser des API enregistrent les applications dans l'organisation d'un fournisseur d'API sur Apigee Edge.

Lorsque l'application est enregistrée, Apigee génère une clé API et un code secret qui identifient l'application. Le développeur intègre la clé API dans l'application, qui présente la clé lors de l'envoi de requêtes. Les services d'API mettent en œuvre la sécurité autour de la clé API via la validation directe des clés API ou via OAuth.

Contexte d'exécution pour les proxys d'API. Un proxy d'API doit être déployé dans un environnement avant que l'API qu'il expose ne soit accessible sur le réseau. Par défaut, les organisations sont provisionnées avec deux environnements : test et prod.

• L'environnement test est généralement utilisé pour déployer des proxys d'API pendant le développement.
• L'environnement prod est généralement utilisé pour promouvoir les proxys d'API de l'environnement de test une fois qu'ils ont été entièrement développés et testés.

Conteneur pour tous les objets d'un compte Apigee Edge, y compris les serveurs proxy d'API, les produits d'API, les packages d'API, les applications et les développeurs.

Vous devez posséder un compte utilisateur pour chaque organisation dont vous êtes membre. (La plupart des utilisateurs disposent d'un compte dans une seule organisation.)

Étape de traitement qui s'exécute comme une unité de logique atomique et réutilisable dans un flux de traitement de proxy d'API.

Une fonctionnalité type basée sur des règles comprend la transformation d'un format de message, l'application du contrôle des accès, l'appel de services distants pour obtenir des informations supplémentaires, le masquage des données sensibles auprès des utilisateurs externes, la vérification du contenu des messages pour détecter les menaces potentielles, la mise en cache des réponses courantes pour améliorer les performances, etc.

Les règles peuvent être exécutées de manière conditionnelle en fonction du contenu ou du contexte d'un message de requête ou de réponse. Par exemple, une règle de transformation peut être exécutée pour personnaliser un format de réponse si le message de la requête a été envoyé depuis un smartphone.

Version de l'interface de l'API destinée aux développeurs.

Par exemple, pivotaltracker.com/services/v3 ou api.enterprise.apigee.com/v1.

Ce terme est différent d'une révision, qui correspond au package de configuration et de règles regroupées dans un proxy d'API, numéroté et contrôlé par la version. Les versions s'appliquent aux interfaces d'API et les révisions aux proxys d'API.