Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
Effectuer des demandes d'API
Les demandes de requête pour les autorisations Amazon Verified sont des requêtes HTTP ou HTTPS qui utilisent cette POST méthode.
Points de terminaison d'autorisations vérifiés
Un point de terminaison est une URL qui sert de point d'entrée à un service Web. Vous pouvez sélectionner un point de Région AWS terminaison approprié lorsque vous faites vos demandes afin de réduire le temps de latence. Pour plus d'informations sur les points de terminaison utilisés par Verified Permissions, consultez Amazon Verified Permissions dans le Référence générale d'Amazon Web Services.
Paramètres de demande
Amazon Verified Permissions utilise un JSON-based protocole. Vous transmettez les paramètres de requête au format JSON dans le corps de votre requête HTTP. Les listes sont représentées sous forme de tableaux JSON. Pour plus d'informations, consultez la section Paramètres communs dans le manuel Amazon Verified Permissions API Reference.
Identifiants de demande
Dans chaque réponse, AWS renvoie un ID de demande via l'en-tête de réponse x-amzn-RequestId HTTP. Cette chaîne est un identifiant unique attribué pour fournir AWS des informations de suivi. Bien que l'ID de demande soit inclus dans chaque réponse, il n'est pas répertorié sur les pages de documentation de l'API individuelles afin d'améliorer la lisibilité et de réduire la redondance.
Authentification par API de requête
Vous envoyez des requêtes via HTTPS. Vous devez inclure une signature dans chaque demande de requête. Pour plus d'informations sur la création et l'inclusion d'une signature, consultez la section Signature des demandes d' AWS API dans le Référence générale d'Amazon Web Services.
Bibliothèques disponibles
AWS fournit des bibliothèques, des exemples de code, des didacticiels et d'autres ressources aux développeurs de logiciels qui préfèrent créer des applications à l'aide d'API spécifiques au langage plutôt que des outils de ligne de commande et de l'API de requête. Ces bibliothèques fournissent des fonctions de base (non incluses dans les API), telles que l'authentification des demandes, les nouvelles tentatives et la gestion des erreurs, afin de faciliter le démarrage. Les bibliothèques et ressources d'autorisations vérifiées sont disponibles pour les langues et plateformes suivantes :
Pour plus d'informations sur les bibliothèques et les exemples de code dans tous les langages, voir Exemples de code et bibliothèques.
Effectuer des demandes d'API à l'aide de la méthode POST
Si vous n'utilisez aucun des AWS SDK, vous pouvez effectuer des demandes d'autorisations vérifiées via HTTPS à l'aide de la méthode de POST demande. La POST méthode nécessite que vous spécifiiez l'opération dans l'en-tête de la demande et que vous fournissiez les données de l'opération au format JSON dans le corps de la demande.
| Nom de l’en-tête | Valeur d’en-tête |
|---|---|
Host |
Le point de terminaison Amazon Verified Permissions. Par exemple : |
X-Amz-Date |
Vous devez fournir l'horodatage dans l'en-tête HTTP Date ou dans l'en-tête AWS x-amz-date. Certaines bibliothèques clientes HTTP ne vous permettent pas de définir l'en-tête Date. Lorsqu'un en-tête x-amz-date est présent, le système ignore tout en-tête Date lors de l'authentification de la demande. L'en-tête x-amz-date doit être spécifié au format de base ISO 8601. Par exemple : |
Authorization |
Ensemble de paramètres d'autorisation AWS utilisé pour garantir la validité et l'authenticité de la demande. Pour plus d'informations sur la création de cet en-tête, voir Processus de signature de la version 4 de Signature dans le Référence générale d'Amazon Web Services. |
X-Amz-Target |
Spécifie l'opération d'autorisations vérifiées que vous souhaitez effectuer.
Par exemple, pour appeler l'
|
Content-Type |
Spécifie le format d'entrée. Utilisez la valeur suivante.
|
Accept |
Spécifie le format de réponse. Utilisez la valeur suivante.
|
Content-Length |
Taille de la charge utile en octets. |
Content-Encoding |
Spécifie le format de codage de l'entrée et de la sortie. Utilisez la valeur suivante.
|
Voici un exemple d'en-tête pour une requête HTTP renvoyant une liste de toutes les politiques du magasin de politiques spécifié, Compte AWS où elles font Principal référence à un User nomalice. Dans cet exemple, la Authorization ligne est encapsulée ici pour en faciliter la lecture. Ne l'inscrivez pas dans votre demande réelle.
POST / HTTP/1.1 Host: verifiedpermissions.us-east-1.amazonaws.com X-Amz-Date: 20230101T200059Z Accept-Encoding: identity Content-Type: application/x-amz-json-1.0 X-Amz-Target: VerifiedPermissions.ListPolicies User-Agent: <UserAgentString> Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=<Headers>, Signature=<Signature> Content-Length: <PayloadSizeBytes> { "PolicyStoreId": "PSExAmPLE222222222", "Filter": { "Principal": { "Id": { "EntityType": "User", "EntityId": "alice" } } } }
