L'explorateur d'API vous permet d'explorer et d'exécuter toutes les méthodes clés de l'API brainCloud. Il simule une application cliente communiquant avec les serveurs brainCloud. C'est un excellent moyen de tester les API et de confirmer leurs comportements et leurs formats de retour JSON.
L'écran de l'explorateur se compose des éléments suivants :
Résumé - Cette section affiche des informations sur la session actuellement active, y compris l'ID de session actif et l'ID du profil.
Service : Vous permet de sélectionner l'un des nombreux services brainCloud. Une fois le service sélectionné, la liste des opérations s'actualise pour refléter les méthodes disponibles.
Opération - L'opération (méthode API) à invoquer.
Description - Une description de la méthode, accompagnée d'un lien vers la page de référence API appropriée.
Paramètres : Les paramètres à envoyer à la méthode. Ils seront pré-remplis avec un modèle par défaut, que vous pourrez modifier manuellement pour simuler votre test.
[EXÉCUTER] - cliquer sur le bouton
EXÉCUTERexécute la requête.Journaux - le journal est mis à jour pour afficher chaque requête, suivie de sa réponse - avec un décompte du nombre de millisecondes nécessaires à l'exécution de l'opération.
Remarques
Authentification - Le portail pré-remplis automatiquement votre e-mail de développement comme identifiant et mot de passe pour l'authentification - utile pour créer des usagers de test.
Expiration des sessions : la session créée avec l'explorateur d'API reste active même lorsque vous accédez à d'autres parties du portail. Cette option est utile pour exécuter une opération, puis analyser son effet via la surveillance globale ou usager. Les sessions expirent après environ 15 minutes.
Se connecter en tant qu'usager - Si vous souhaitez vous connecter en tant qu'usager spécifique à des fins de test/débogage, vous pouvez localiser cet usager via le navigateur d'usager, puis cliquer sur le bouton [Se connecter en tant qu'usager] en haut à droite de la page.
Pour commencer, le premier appel à exécuter sur votre application est l'appel d'initialisation, qui permet d'associer votre client à votre application sur brainCloud. Puisque vous êtes déjà dans le contexte de votre application depuis le portail, vous devez effectuer l'étape suivante : l'authentification .
Contourner la vérification App Activée vous permettra de continuer à exécuter des appels d'API si vous avez désactivé votre application sur la page Conception > Info de base de l'app > Réglages avancés .
Pour chaque opération sélectionnée, vous verrez une description de ce que fait le service, ainsi qu'un lien de référence API.
Une fois authentifié, testez l'appel API en suivant les étapes suivantes :
Accédez au service Entity et à l’opération CreateEntity , qui vous permettra de créer des objets de données connectés au profil usager actuel.
Modifiez la valeur du paramètre entityType en myEntityType , puis cliquez sur le bouton
EXECUTE.
Exemple :
Vous pouvez revenir en arrière pour vérifier les requêtes et les réponses que vous avez effectuées via la section des journaux ou copier ces journaux à des fins de débogage.
Notez également que si vous voyez certaines méthodes avec un badge spécial, cela signifie qu'elles ne peuvent être appelées qu'à partir de Cloud Code.
