Service d'authentification - Spécifications et utilisation
Spécifications
Pour utiliser les services de Gosu vous devez remplir les conditions suivantes lors de votre authentification :
- Utiliser un identifiant et un mot de passe valide
- Posséder les droits d'utilisation du web service (être administrateur où s'être vu attribuer l'autorisation via le module de gestion des utilisateurs)
- Avoir un compte utilisateur actif
Schémas
Le schéma utilisé pour les requêtes est disponible à l'adresse suivante : token-request.xsd
Le schéma utilisé pour les réponses est disponible à l'adresse suivante : token-response.xsd
Description des paramètres
| Code | Format | Obligatoire | Description |
|---|---|---|---|
| login | Chaine de caractères | Oui | Identifiant de l'utilisateur |
| password | Chaine de caractères | Oui | Mot de passe de l'utilisateur |
| universeFilters | Chaine de caractères, caractère de séparation "," | Non | Liste d'univers sur lesquels filtrer la liste de comptes
accessibles lors d'une réponse d'authentification valide. Les
univers disponibles sont :
|
Pour des exemples de requêtes détaillant l'utilisation de ces différents paramètres, merci de consulter la section Exemples de requêtes.
Réponses d'authentification
Un exemple de réponse du service d'authentification est présent ci-dessous. Certains éléments ont été omis pour plus de clarté.
<tokenResponse> <tokenId>9bdaaa381bb182280afaaa0b96aa680aaa917efd03683d8d01bdaaaaaaaaaaaa</tokenId> <universe code="STREAMING"> <serial serialName="Bbox+test" serialNumber="123456"/> <serial serialName="Compte+de+cumul+Dailymotion+Catchup" serialNumber="123789"/> ... plus de comptes </universe> <universe code="PODCAST"> <serial serialName="+rapport+%27AdsClick%27" serialNumber="789456" serialLevel="4"/> <serial serialName="Nouvelle+interface+eStat%5C%27persos" serialNumber="789123"/> ... plus de comptes </universe> </tokenResponse>
Jeton
Le champ tokenId contient le jeton à utiliser lors des requêtes suivantes.
Liste d'univers
A la connexion, les comptes accessibles à l'utilisateurs sont indiqués, classés par univers. Chaque section universe indique le code de l'univers puis une liste de comptes accessibles.
Comptes
Chaque serial représente un compte avec son identifiant, son nom et le nombre de niveaux lorsque l'univers possède cette distinction.
Cas d'erreur
Explications
Dans le cas d'une requête invalide, une réponse d'erreur contenant un code et un message est renvoyée. Pour plus d'information sur les codes d'erreur et leur signification, merci de consulter la liste des erreurs.
Exemple de réponse d'erreur
<tokenResponse> <errorCode>253</errorCode> <errorMessage>Incorrect+login+or+password</errorMessage> </tokenResponse>