Partager via

Référence du modèle de données de gestion des API Azure

Cette rubrique décrit les représentations d’entité et de type pour les éléments courants utilisés dans les modèles de données pour les modèles du portail des développeurs dans Gestion des API Azure.

Pour plus d’informations sur l’utilisation de modèles, consultez la page Guide pratique de personnalisation du portail des développeurs Gestion des API à l’aide de modèles.

Remarque

Le contenu de la documentation suivante s’applique au portail des développeurs déconseillé. Vous pouvez continuer à l’utiliser normalement jusqu’à sa suppression en octobre 2023, lorsqu’il sera supprimé de tous les services de gestion des API. Le portail obsolète recevra uniquement les mises à jour de sécurité critiques. Pour plus d’informations, reportez-vous aux articles suivants :

S’APPLIQUE À : Développeur | De base | Standard | Premium

Référence

API (Interface de Programmation d'Applications)

L’entité API a les propriétés suivantes :

Propriété Catégorie Descriptif
id ficelle Identificateur de ressource. Identifie de manière unique l’API dans l’instance actuelle du service Gestion des API. La valeur est une URL relative valide au format où apis/{id}{id} est un identificateur d’API. Cette propriété est en lecture seule.
name ficelle Nom de l’API. Ne doit pas être vide. La longueur maximale est de 100 caractères.
description ficelle Description de l’API. Ne doit pas être vide. Peut inclure des balises de mise en forme HTML. La longueur maximale est de 1 000 caractères.
serviceUrl ficelle URL absolue du service principal implémentant cette API.
path ficelle URL relative identifiant de manière unique cette API et tous ses chemins de ressources dans l’instance du service Gestion des API. Elle est ajoutée à l’URL de base du point de terminaison d’API spécifiée pendant la création de l’instance de service pour former une URL publique pour cette API.
protocols tableau de nombres Décrit les protocoles sur lesquels les opérations de cette API peuvent être appelées. Les valeurs autorisées sont 1 - http et 2 - https, ou les deux.
authenticationSettings Paramètres d’authentification du serveur d’autorisation Collection de paramètres d’authentification inclus dans cette API.
subscriptionKeyParameterNames objet Propriété facultative qui peut être utilisée pour spécifier des noms personnalisés pour les paramètres de requête et/ou d’en-tête contenant la clé d’abonnement. Lorsque cette propriété est présente, elle doit contenir au moins l’une des deux propriétés suivantes.

{ "subscriptionKeyParameterNames": { "query": “customQueryParameterName", "header": “customHeaderParameterName" } }

Résumé de l’API

L’entité API summary a les propriétés suivantes :

Propriété Catégorie Descriptif
id ficelle Identificateur de ressource. Identifie de manière unique l’API dans l’instance actuelle du service Gestion des API. La valeur est une URL relative valide au format où apis/{id}{id} est un identificateur d’API. Cette propriété est en lecture seule.
name ficelle Nom de l’API. Ne doit pas être vide. La longueur maximale est de 100 caractères.
description ficelle Description de l’API. Ne doit pas être vide. Peut inclure des balises de mise en forme HTML. La longueur maximale est de 1 000 caractères.

Application

L’entité application a les propriétés suivantes :

Propriété Catégorie Descriptif
Id ficelle Identificateur unique de l’application.
Title ficelle Titre de l’application.
Description ficelle Description de l’application.
Url URI URI de l’application.
Version ficelle Informations de version pour l’application.
Requirements ficelle Description des conditions requises pour l’application.
State nombre État actuel de l’application.

- 0 - Inscrit

- 1 - Soumis

- 2 - Publié

- 3 - Rejeté

- 4 - Non publié
RegistrationDate Date et heure Date et heure d’inscription de l’application.
CategoryId nombre Catégorie de l’application (Finance, divertissement, etc.)
DeveloperId ficelle Identificateur unique du développeur qui a soumis l’application.
Attachments Collection d’entités attachment . Toutes les pièces jointes de l’application, telles que des captures d’écran ou des icônes.
Icon Pièce jointe L’icône de l’application.

Pièce jointe

L’entité attachment a les propriétés suivantes :

Propriété Catégorie Descriptif
UniqueId ficelle Identificateur unique de la pièce jointe.
Url ficelle URL de la ressource.
Type ficelle Type de pièce jointe.
ContentType ficelle Type de média de la pièce jointe.

Exemple de code

Propriété Catégorie Descriptif
title ficelle Nom de l’opération.
snippet ficelle Cette propriété est déconseillée et ne doit pas être utilisée.
brush ficelle Modèle de coloration de syntaxe de code à utiliser lors de l’affichage de l’exemple de code. Les valeurs autorisées sont plain, , phpjava, xmlobjcpythonrubyet .csharp
template ficelle Nom de cet exemple de modèle de code.
body ficelle Espace réservé pour un exemple de code.
method ficelle Méthode HTTP de l’opération.
scheme ficelle Protocole à utiliser pour la demande d’opération.
path ficelle Chemin de l’opération.
query ficelle Exemple de chaîne de requête avec des paramètres définis.
host ficelle URL de la passerelle de service Gestion des API pour l’API qui contient cette opération.
headers Collection d'entités d'en-tête. En-têtes pour cette opération.
parameters Collection d’entités Parameter . Paramètres définis pour cette opération.

Commentaire

L’entité API a les propriétés suivantes :

Propriété Catégorie Descriptif
Id nombre ID du commentaire.
CommentText ficelle Corps du commentaire. Peut inclure du code HTML.
DeveloperCompany ficelle Nom de la société du développeur.
PostedOn Date et heure Date et heure de publication du commentaire.

Problème

L’entité issue a les propriétés suivantes.

Propriété Catégorie Descriptif
Id ficelle Identificateur unique du problème.
ApiID ficelle ID de l’API pour laquelle ce problème a été signalé.
Title ficelle Titre du problème.
Description ficelle Description du problème.
SubscriptionDeveloperName ficelle Prénom du développeur qui a signalé le problème.
IssueState ficelle État actuel du problème. Les valeurs possibles sont Proposées, Ouvertes, Fermées.
ReportedOn Date et heure Date et heure du signalement du problème.
Comments Collection d’entités Commentaire. Commentaires sur ce problème.
Attachments Collection d’entités attachment . Toutes les pièces jointes au problème.
Services Collection d’entités API. Les API abonnées par l’utilisateur qui ont déposé le problème.

Filtrage

L’entité filtering a les propriétés suivantes :

Propriété Catégorie Descriptif
Pattern ficelle Terme de recherche actuel ; ou null s’il n’existe aucun terme de recherche.
Placeholder ficelle Texte à afficher dans la zone de recherche lorsqu’aucun terme de recherche n’est spécifié.

Cette section décrit la parameter représentation.

Propriété Catégorie Descriptif
name ficelle Nom du paramètre.
description ficelle Description du paramètre.
value ficelle Valeur d’en-tête.
typeName ficelle Type de données pour la valeur de l’en-tête.
options ficelle Options.
required booléen Indique si l’en-tête est requis.
readOnly booléen Indique si l’en-tête est en lecture seule.

Requête HTTP

Cette section décrit la request représentation.

Propriété Catégorie Descriptif
description ficelle Description de la demande d’opération.
headers tableau d’entités d’en-tête. En-têtes de requête.
parameters tableau de paramètres Collection de paramètres de demande d’opération.
representations tableau de représentation Collection des demandes de représentation d'opération.

Réponse HTTP

Cette section décrit la response représentation.

Propriété Catégorie Descriptif
statusCode entier positif Code d’état de réponse de l’opération.
description ficelle Description de la réponse de l’opération.
representations tableau de représentation Collection de représentations de réponse d’opération.

Opération

L’entité operation a les propriétés suivantes :

Propriété Catégorie Descriptif
id ficelle Identificateur de ressource. Identifie de manière unique l’opération dans l’instance actuelle du service Gestion des API. La valeur est une URL relative valide au format où apis/{aid}/operations/{id}{aid} est un identificateur d’API et {id} un identificateur d’opération. Cette propriété est en lecture seule.
name ficelle Nom de l’opération. Ne doit pas être vide. La longueur maximale est de 100 caractères.
description ficelle Description de l’opération. Ne doit pas être vide. Peut inclure des balises de mise en forme HTML. La longueur maximale est de 1 000 caractères.
scheme ficelle Décrit les protocoles sur lesquels les opérations de cette API peuvent être appelées. Les valeurs autorisées sont http, httpsou les deux http et https.
uriTemplate ficelle Modèle d’URL relative identifiant la ressource cible pour cette opération. Peut inclure des paramètres. Exemple : customers/{cid}/orders/{oid}/?date={date}
host ficelle URL de la passerelle Gestion des API qui héberge l’API.
httpMethod ficelle Méthode HTTP d’opération.
request Requête HTTP Entité contenant les détails de la demande.
responses tableau de réponse HTTP Tableau d’opération d’entités de réponse HTTP.

L’entité operation menu a les propriétés suivantes :

Propriété Catégorie Descriptif
ApiId ficelle ID de l’API actuelle.
CurrentOperationId ficelle ID de l’opération actuelle.
Action ficelle Type de menu.
MenuItems Collection d'entités d'éléments de menu d'Opération. Opérations de l’API actuelle.

L’entité operation menu item a les propriétés suivantes :

Propriété Catégorie Descriptif
Id ficelle ID de l’opération.
Title ficelle Description de l’opération.
HttpMethod ficelle Méthode HTTP utilisée dans l'opération.

Feuilletage

L’entité paging a les propriétés suivantes :

Propriété Catégorie Descriptif
Page nombre Le numéro de la page actuelle.
PageSize nombre Résultats maximum à afficher sur une seule page.
TotalItemCount nombre Nombre d’éléments à afficher.
ShowAll booléen Indiquer s'il faut afficher tous les résultats sur une seule page.
PageCount nombre Nombre de pages de résultats.

Paramètre

Cette section décrit la parameter représentation.

Propriété Catégorie Descriptif
name ficelle Nom du paramètre.
description ficelle Description du paramètre.
value ficelle Valeur du paramètre.
options tableau de chaînes Valeurs définies pour les valeurs des paramètres de requête.
required booléen Spécifie si le paramètre est obligatoire ou non.
kind nombre Indique si ce paramètre est un paramètre de chemin d’accès (1) ou un paramètre querystring (2).
typeName ficelle Type de paramètre.

Produit

L’entité product a les propriétés suivantes :

Propriété Catégorie Descriptif
Id ficelle Identificateur de ressource. Identifie de manière unique le produit dans l’instance actuelle du service Gestion des API. La valeur est une URL relative valide au format de products/{pid} où {pid} est un identificateur de produit. Cette propriété est en lecture seule.
Title ficelle Nom du produit. Ne doit pas être vide. La longueur maximale est de 100 caractères.
Description ficelle Description du produit. Ne doit pas être vide. Peut inclure des balises de mise en forme HTML. La longueur maximale est de 1 000 caractères.
Terms ficelle Conditions d’utilisation du produit. Les développeurs qui essaient de s’abonner au produit sont présentés et doivent accepter ces conditions avant de pouvoir terminer le processus d’abonnement.
ProductState nombre Spécifie si le produit est publié ou non. Les produits publiés sont détectables par les développeurs sur le portail des développeurs. Les produits non publiés ne sont visibles que par les administrateurs.

Les valeurs autorisées pour l’état du produit sont les suivantes :

- 0 - Not Published

- 1 - Published

- 2 - Deleted
AllowMultipleSubscriptions booléen Spécifie si un utilisateur peut avoir plusieurs abonnements à ce produit en même temps.
MultipleSubscriptionsCount nombre Le nombre maximal d’abonnements à ce produit qu’un utilisateur est autorisé à avoir en même temps.

Fournisseur

L’entité provider a les propriétés suivantes :

Propriété Catégorie Descriptif
Properties dictionnaire de chaînes Propriétés de ce fournisseur d’authentification.
AuthenticationType ficelle Type de fournisseur. (Microsoft Entra ID, connexion Facebook, compte Google, compte Microsoft, Twitter).
Caption ficelle Nom affiché du fournisseur.

Représentation

Cette section décrit un representation.

Propriété Catégorie Descriptif
contentType ficelle Spécifie un type de contenu inscrit ou personnalisé pour cette représentation, par exemple application/xml.
sample ficelle Exemple de représentation.

Abonnement

L’entité subscription a les propriétés suivantes :

Propriété Catégorie Descriptif
Id ficelle Identificateur de ressource. Identifie de manière unique l’abonnement dans l’instance actuelle du service Gestion des API. La valeur est une URL relative valide au format de subscriptions/{sid} où {sid} est un identificateur d’abonnement. Cette propriété est en lecture seule.
ProductId ficelle L'identificateur de ressource du produit souscrit. La valeur est une URL relative valide au format de products/{pid} où {pid} est un identificateur de produit.
ProductTitle ficelle Nom du produit. Ne doit pas être vide. La longueur maximale est de 100 caractères.
ProductDescription ficelle Description du produit. Ne doit pas être vide. Peut inclure des balises de mise en forme HTML. La longueur maximale est de 1 000 caractères.
ProductDetailsUrl ficelle URL relative aux détails de produit.
state ficelle État de l’abonnement. Les états possibles sont :

- 0 - suspended : l’abonnement est bloqué et l’abonné ne peut pas appeler d’API du produit.

- 1 - active : l’abonnement est actif.

- 2 - expired : l’abonnement a atteint sa date d’expiration et a été désactivé.

- 3 - submitted : la demande d’abonnement a été faite par le développeur, mais n’a pas encore été approuvée ou rejetée.

- 4 - rejected : la demande d’abonnement a été refusée par un administrateur.

- 5 - cancelled : l’abonnement a été annulé par le développeur ou l’administrateur.
DisplayName ficelle Nom affiché de l’abonnement.
CreatedDate date et heure Date de création de l’abonnement au format ISO 8601 : 2014-06-24T16:25:00Z.
CanBeCancelled booléen Indique si l’abonnement peut être annulé par l’utilisateur actuel.
IsAwaitingApproval booléen Indique si l’abonnement attend l’approbation.
StartDate date et heure Date de début de l’abonnement, au format ISO 8601 : 2014-06-24T16:25:00Z.
ExpirationDate date et heure Date d’expiration de l’abonnement, au format ISO 8601 : 2014-06-24T16:25:00Z.
NotificationDate date et heure Date de notification de l’abonnement, au format ISO 8601 : 2014-06-24T16:25:00Z.
primaryKey ficelle Clé d’abonnement primaire. La longueur maximale est de 256 caractères.
secondaryKey ficelle Clé d’abonnement secondaire. La longueur maximale est de 256 caractères.
CanBeRenewed booléen Indique si l’abonnement peut être renouvelé par l’utilisateur actuel.
HasExpired booléen Indique si l’abonnement a expiré.
IsRejected booléen Indique si la demande d’abonnement a été refusée.
CancelUrl ficelle URL relative pour annuler l’abonnement.
RenewUrl ficelle URL relative pour renouveler l’abonnement.

Résumé de l’abonnement

L’entité subscription summary a les propriétés suivantes :

Propriété Catégorie Descriptif
Id ficelle Identificateur de ressource. Identifie de manière unique l’abonnement dans l’instance actuelle du service Gestion des API. La valeur est une URL relative valide au format de subscriptions/{sid} où {sid} est un identificateur d’abonnement. Cette propriété est en lecture seule.
DisplayName ficelle Nom d'affichage de l'abonnement

Informations sur le compte d’utilisateur

L’entité user account info a les propriétés suivantes :

Propriété Catégorie Descriptif
FirstName ficelle Prénom. Ne doit pas être vide. La longueur maximale est de 100 caractères.
LastName ficelle Nom. Ne doit pas être vide. La longueur maximale est de 100 caractères.
Email ficelle Adresse e-mail. Doit être unique et ne pas être vide au sein de l’instance de service. La longueur maximale est de 254 caractères.
Password ficelle Mot de passe du compte d’utilisateur.
NameIdentifier ficelle Identificateur de compte, identique à l’e-mail de l’utilisateur.
ProviderName ficelle Nom du fournisseur d’authentification.
IsBasicAccount booléen True si ce compte a été inscrit à l’aide de l’e-mail et du mot de passe ; false si le compte a été inscrit à l’aide d’un fournisseur.

Se connecter

L’entité user sign in a les propriétés suivantes :

Propriété Catégorie Descriptif
Email ficelle Adresse e-mail. Doit être unique et ne pas être vide au sein de l’instance de service. La longueur maximale est de 254 caractères.
Password ficelle Mot de passe du compte d’utilisateur.
ReturnUrl ficelle URL de la page dans laquelle l’utilisateur a cliqué sur se connecter.
RememberMe booléen Indique s’il faut enregistrer les informations de l’utilisateur actuel.
RegistrationEnabled booléen Indique si l’inscription est activée.
DelegationEnabled booléen Indique si la connexion déléguée est activée.
DelegationUrl ficelle URL de connexion déléguée, si elle est activée.
SsoSignUpUrl ficelle URL d’authentification unique pour l’utilisateur, le cas échéant.
AuxServiceUrl ficelle Si l’utilisateur actuel est administrateur, il s’agit d’un lien vers l’instance de service dans le portail Azure.
Providers Collection d'entités Provider Fournisseurs d’authentification pour cet utilisateur.
UserRegistrationTerms ficelle Conditions auxquelles un utilisateur doit accepter avant de se connecter.
UserRegistrationTermsEnabled booléen Indique si les termes sont activés.

Inscription de l’utilisateur

L’entité user sign up a les propriétés suivantes :

Propriété Catégorie Descriptif
PasswordConfirm booléen Valeur utilisée par le contrôle d’inscription.
Password ficelle Mot de passe du compte d’utilisateur.
PasswordVerdictLevel nombre Valeur utilisée par le contrôle d’inscription.
UserRegistrationTerms ficelle Conditions auxquelles un utilisateur doit accepter avant de se connecter.
UserRegistrationTermsOptions nombre Valeur utilisée par le contrôle d’inscription.
ConsentAccepted booléen Valeur utilisée par le contrôle d’inscription.
Email ficelle Adresse e-mail. Doit être unique et ne pas être vide au sein de l’instance de service. La longueur maximale est de 254 caractères.
FirstName ficelle Prénom. Ne doit pas être vide. La longueur maximale est de 100 caractères.
LastName ficelle Nom. Ne doit pas être vide. La longueur maximale est de 100 caractères.
UserData ficelle Valeur utilisée par le contrôle d’inscription .
NameIdentifier ficelle Valeur utilisée par le contrôle d’inscription.
ProviderName ficelle Nom du fournisseur d’authentification.

Étapes suivantes

Pour plus d’informations sur l’utilisation de modèles, consultez la page Guide pratique de personnalisation du portail des développeurs Gestion des API à l’aide de modèles.

  • Last updated on