brainCloud prend en charge deux variétés d'appels S2S : avec et sans sessionId.
Lors d'un appel d'API S2S sans sessionId, une sessionId jetable est rapidement généré et supprimé après l'appel. Remarque : cet appel d'authentification supplémentaire est facturé. Cette approche est rapide et pratique pour les tests, mais n'est pas recommandée.
Pour utiliser le protocole basé sur les sessions, vous devez d'abord vous authentifier afin d'obtenir une sessionId. Vous réutiliserez ensuite cette sessionId lors des appels ultérieurs, tout en incrémentant la valeur du packetId.
[Remarque : les messages S2S basés sur la session permettent de regrouper plusieurs API au sein d'une même requête. Cela peut s'avérer très utile dans certaines circonstances.]
Globalement, le protocole S2S basé sur les sessions est recommandé pour les applications de production, car il élimine la création redondante de sessions jetables. C'est plus performant et moins coûteux !
Installation de PostMan
Assez simple :
Télécharger depuis https://www.getpostman.com/
Choisissez votre plateforme actuelle et terminez le processus d'installation
Utilisation de PostMan comme S2S (sans SessionId)
Ajouter une nouvelle requête
Définir la requête comme Post
Définissez l'URL de la requête sur : "https://api.braincloudservers.com/s2sdispatcher"
Sélectionner Body | Text | JSON (application/json)
Sélectionnez raw et ajoutez votre JSON ( voir l'exemple ci-dessous )
Sélectionnez Send
Voir la réponse
{
//Définissez l'ID de votre application
"appId": "12142",
//Définissez le nom du serveur utilisé.
//Nom du serveur ?
// Faites défiler vers le bas pour trouver une explication
"serverName": "EXAMPLE_SERVER",
//Définissez le secret de votre serveur
"serverSecret": "b221c2a4-8df9-4937-8f9b-a95e4f71d5b6",
//Définissez le service appelé. Tous les services ne sont pas disponibles dans un contexte S2S ; consultez la référence API pour une liste complète.
//http://getbraincloud.com/apidocs/apiref/#s2s
"service": "script",
//Définissez l'opération en cours d'exécution
//Service et opération ?
// Faites défiler vers le bas pour trouver une explication
"operation": "RUN",
//Définissez les données utilisées par cet appel d'API
"data": {
"scriptName": "AddNums",
"scriptData": {
"a": 3,
"b": 4
}
}
}
Utilisation de PostMan comme S2S (avec session)
Tout d’abord, nous devons nous authentifier pour obtenir une SessionId
Ajouter une nouvelle requête
Définir la requête comme Post
Définissez l'URL de la requête sur : "https://api.braincloudservers.com/s2sdispatcher"
Sélectionner Body | Text | JSON (application/json)
Sélectionnez raw et ajoutez votre JSON ( voir l'exemple ci-dessous )
Affichez la réponse et enregistrez cette sessionId.
{
//Définissez l'ID de votre application
"appId": "12142",
//Définissez le nom du serveur utilisé.
//Nom du serveur d'applications ?
// Faites défiler vers le bas pour trouver l'explication
"serverName": "EXAMPLE_SERVER",
// Définissez le secret de votre serveur
"serverSecret": "b221c2a4-8df9-4937-8f9b-a95e4f71d5b6",\
// Définissez le service et l'opération sur 'authenticationV2' et 'AUTHENTICATE'
"service": "authenticationV2",
"operation": "AUTHENTICATE",
// Définissez l'appId, le serverName et le serverSecret dans ce package de données
"data": {
"appId": "12142",
"serverName": "EXAMPLE_SERVER",
"serverSecret": "b221c2a4-8df9-4937-8f9b-a95e4f71d5b6"
}
}
Maintenant, nous pouvons effectuer un appel API avec cette sessionId
Ajouter une nouvelle requête
Définir la requête comme Post
Définissez l'URL de la requête sur : "https://api.braincloudservers.com/s2sdispatcher"
Sélectionner Body | Text | JSON (application/json)
Sélectionnez raw et ajoutez votre JSON ( voir l'exemple ci-dessous )
Voir la réponse.
N'oubliez pas d'incrémenter le packetId pour chaque requête que vous effectuez avec cette sessionId.
{
//Définissez l'identifiant de session (sessionId) précédent
"sessionId":"df5gelac0mhrpht31fagtgatoe",
//Définissez le packetId. Vous devez l'incrémenter de un à chaque requête
"packetId":1,
// Joignez les appels d'API que vous effectuez à une liste.
"messages":[
{
"service":"globalEntity",
"operation":"CREATE_SYSTEM_ENTITY",
"data":{
"entityType":"address",
"timeToLive":null,
"acl":{
"other":1
},
"data":{
"street":"1309 Carling"
}
}
}
]
}
Nom du serveur ?
Le nom du serveur est créé sur le tableau de bord brainCloud. Cela permet à brainCloud de savoir que vos connexions PostMan proviennent d'un serveur que vous possédez et ne sont pas malveillantes.
1. Accédez à votre projet d'application brainCloud. https://portal.braincloudservers.com
2. Conception > Serveurs > Mes Serveurs. Cliquez sur le bouton [Ajouter une nouveau serveur].
3. Sélectionnez Serveur personnalisé dans le menu déroulant Type de serveur.
4. Donnez un nom à votre serveur, comme EXAMPLE_SERVER
5. Vous pouvez laisser les plages vides. Cela rendra toutes les plages IP acceptables.
6. Cliquez sur Appliquer et vous aurez désormais le secret du serveur.
Le tableau de bord brainCloud est également l'endroit où vous trouverez l'ID de l'app. Conception > Info de base de l'App > IDs de l'Application .
Service et Opération ?
Nos appels API référencés dans l'API Ref ( https://docs.braincloudservers.com/api/s2s/ ) sont mappés aux services et aux opérations sur le serveur.
Les opérations indiquent comment les appels d'API apparaissent côté serveur.
Les services sont le groupe de brainCloud que les opérations affectent. c'est-à-dire qu'une opération UPDATE a peu de sens sans savoir si elle affecte les statistiques, les succès, le multijoueur ou d'autres contextes de service.
Seuls les appels API de la section S2S peuvent être utilisés pour les appels S2S.