Postman est une bonne plateforme pour tester et collaborer avec vos coéquipiers, que vous ayez créé des scripts S2S et appelables par le client ou des API prêtes à l'emploi brainCloud.
Pour installer Postman, il suffit de :
Télécharger depuis https://www.getpostman.com/
Choisissez votre plateforme et terminez le processus d'installation
Exemples S2S
Exemple d'appel de script S2S Cloud Code (sans session)
Suivez le lien du didacticiel Cloud Code pour créer un script S2S et nommez-le "AddNums".
Accédez à la page Conception > Serveurs > Mes serveurs , cliquez sur [+ Ajouter Un Nouveau Serveur], saisissez un nom pour votre serveur (par exemple newGame_SERVER) et sélectionnez Serveur personnalisé dans le menu déroulant Type de serveur.
Laissez l'URL de base et les plages IP vides, puis cliquez sur Sauvegarder . La page du portail générera alors un secret de serveur pour vous.
Maintenant que vous avez créé un script S2S et configuré le serveur S2S dans le tableau de bord brainCloud, vous pouvez les tester depuis Postman.
Ouvrez la requète importée -- script-AddNums, ou créez une requète qui vous appartient en suivant le modèle de l'image ci-dessous (Méthode : POST, URL : https://api.braincloudservers.com/s2sdispatcher ), puis appuyez sur Envoyer ("Send") et vérifiez la réponse.
Remarque : "service" : "script" ; "opération" : "RUN"
Exemple d'appel d'API S2S intégrés à brainCloud (sans session)
Ouvrez la requète importée -- itemCatalog-SYS_GET_CATALOG_ITEMS_PAGE, ou créez votre propre requète en suivant le modèle de l'image ci-dessous (Méthode : POST, URL : https://api.braincloudservers.com/s2sdispatcher ), puis cliquez sur Envoyer ("Send") et vérifiez la réponse.
Remarque : "service" : "itemCatalog" ; "operation" : "SYS_GET_CATALOG_ITEMS_PAGE"
Exemple d'appel d'authentification de l'API BrainCloud S2S (basé sur la session)
Ouvrez la requète importée -- prod-session-based-auth , ou créez votre propre requète en suivant le modèle de l'image ci-dessous (Méthode : POST, URL : https://api.braincloudservers.com/s2sdispatcher ), puis appuyez sur Envoyer ("Send") et vérifiez la réponse.
Remarque : "service" : "authentificationV2" ; "opération" : "AUTHENTICATE"
Copiez le résultat
sessionIdretourné par l'appel d'autorisation ci-dessus.Faites une deuxième requète, en utilisant cette
sessionIdet en définissantpacketIdsur 1, puis appuyez sur Envoyer ("Send") et vérifiez la réponse.
Remarque : "service" : "time" ; "opération" : "READ"
Les appels d'API S2S documentés dans la référence API sont mappés à des services et opérations discrets sur le serveur.
Les codes, ainsi que les paramètres spécifiques à l'opération (spécifiés dans l'objet de données JSON) sont utilisés pour envoyer des commandes au serveur.
Remarque : seuls les appels API de la section S2S de la référence API peuvent être utilisés pour les appels S2S.
Utilisation de Curl
Lorsque vous utilisez la ligne de commande Curl avec des paramètres JSON imbriqués pour tester votre appel d'API S2S, nous vous recommandons de placer les paramètres de l'appel d'API dans un fichier JSON, puis de vous référer à ce fichier avec l'option --data (-d) dans la commande Curl.
curl -d "@paraItemCat.json" -X POST https://sharedprod.braincloudservers.com/s2sdispatcher -H "Content-Type: application/json"
Exemple d'appel d'API client
Chaque requète envoyée au serveur API client brainCloud est associée à une vérification MD5 dans l'en-tête de la requète.
La valeur MD5 est calculée en prenant le "body" envoyé à l'API, en y ajoutant le secret de l'application, puis en calculant le MD5 sur tout cela.
Ce n'est que si la valeur MD5 est présente et vérifiée que le serveur API brainCloud acceptera la requète.
Remarque : Méthode : POST, URL : https://api.braincloudservers.com/dispatcherv2
Ouvrez la requête importée (client-api-authenticateEmail) (ou créez-en une en suivant les étapes ci-dessous) et vérifiez son contenu dans la zone de texte Body . Vous constaterez qu'il s'agit du même format que la requête appelée depuis la page Explorateur d'API du portail brainCloud .
Remarque : l’image suivante est le même appel d’API qui a été appelé depuis la page Conception > Cloud Code > Explorateur d’API du portail brainCloud .
Copiez le contenu demandé à partir de la zone de texte Body et ajoutez-y le secret de l'application (voir l'exemple ci-dessous).
Remarque : votre secret d'application se trouve sur la page Conception > Info de base de l'App > IDs de l'Application du portail brainCloud .
Copiez l’intégralité de la requète et collez-la dans un outil de cryptage MD5 pour générer un "checksum" MD5.
Remarque : Voici quelques liens Web vers des outils de chiffrement MD5
Cliquez sur l'onglet "Headers" dans Postman, ajoutez une clé avec le nom "X-SIG" et collez le "checksum" MD5 comme valeur.
C'est parti ! Cliquez sur le bouton "Envoyer" ("Send") et consultez la réponse du serveur API brainCloud.
Accédez au portail brainCloud Usager > Résumé > Résumé de l'usager pour vérifier l'utilisateur que vous venez de créer à partir de Postman.