Guide d'utilisation Premiers pas
L'application
Kwick est un service de messagerie instantané.
Il permet à plusieurs utilisateurs de rejoindre un espace privé et d'échanger des messages.
Le service
Les développeurs désirant utiliser le service Kwick doivent utiliser l'API REST publique mise à leur disposition.
Toutes les requêtes doivent être asynchrone (AJAX) et de type GET. Les réponses sont toutes au format JSON.L'adresse du point d'entré de l'API est la suivante:
Note Pour éviter les problêmes de sécurité liés aux échanges de données entre domaine, nous vous conseillons d'utiliser le protocole JSONP
Accès public et privé
Le service est composé d'un espace public et d'un espace privé.
Pour accéder à l'espace privé, il faut en premier lieu s'identifier à l'aide de la méthode login.
En retour, un jeton (token) vous sera délivré pour la session en cours.
Important Ce jeton doit être utilisé pour tout les accés à l'espace privé.
Réponse du serveur
La réponse du serveur à vos requête est toujours du même format.
kwick
L'objet kwick renferme les propriétés générales du service:
| Paramêtre | Description |
|---|---|
| version | numéro de version du service |
| completed_in | temp mis par le service pour traiter la demande |
| status | état actuel du service (ok, error, busy) |
| message (optionel) | Si la propriété status renferme les valeurs error ou busy, un messqage d'explication est ajouté |
result
L'objet result renferme le résultat de l'opération. La propriété status est toujours présente, avec comme valeurs possible done ou failure.
D'autres paramétres sont présent suivant la nature de la requête (voir la documentation de l'API)
exemple
{"kwick":
{"version":"0.12",
"completed_in":"0.026",
"status":"ok"},
"result":{"status":"done",
"talk":[
{"timestamp":1327171211,
"content":"salut!",
"user_name":"bob"
},
{"timestamp":1327243631,
"content":"hello ;)",
"user_name":"bill"}
],
"last_timestamp":1327243631}
}