/ping

Accès

Public

Description

Ping le serveur KWICK pour connaitre son état

Paramêtres

aucun

Exemple

http://greenvelvet.alwaysdata.net/kwick/api/ping

Réponse

{"kwick":
    {"version":"0.12",
     "completed_in":"0.026",
     "status":"ok"},
"result":{"ready":true
}
            
Paramêtre Valeurs
ready true, false

/signup/user_name/password

Accès

Public

Description

Inscription d'un nouvel utilisateur.
Note Le user_name ne doit pas être encore inscrit pour que l'inscription soit un succés.

Paramêtres

Nom Description
user_name le nom de l'utilisateur
password mot de passe

Exemple

http://greenvelvet.alwaysdata.net/kwick/api/signup/bill/secret

Réponse

{"kwick":
    {"version":"0.12",
     "completed_in":"0.026",
     "status":"ok"},
"result":{"status":"done",
          "message":"bill is signed up with success",
          "id":4,
          "token": "46efaa193f9a7d8dace33a94e9397842"}
}
            
Paramêtre Valeurs
status done, failure
id l'identifiant de l'utilisateur
token Jeton d'autorisation a utiliser pour tout accés sécurisé
message (optionel) commentaire

/login/user_name/password

Accès

Public

Description

Connection d'un utilisateur afin de pouvoir poster des messages.
Si les identifiants sont corrects, un token est délivré pour la session. Celui si permet d'accéder aux méthodes privées du service

Note L'innactivité durant plus de 20 minutes déconnecte automatiquement l'utilisateur

Paramêtres

Nom Description
user_name le nom de l'utilisateur
password mot de passe

Exemple

http://greenvelvet.alwaysdata.net/kwick/api/login/bill/secret

Réponse

{"kwick":
    {"version":"0.12",
     "completed_in":"0.026",
     "status":"ok"},
"result":{"status":"done",
          "message":"welcome new user bill",
          "id":4,
          "token": "46efaa193f9a7d8dace33a94e9397842"}
}
            
Paramêtre Valeurs
status done, failure
id l'identifiant de l'utilisateur
token Jeton d'autorisation a utiliser pour tout accés sécurisé
message (optionel) commentaire

/logout/token/user_id

Accès

Privé

Description

Deconnection de l'utilisateur

Paramêtres

Nom Description
token Le jeton de session délivré lors de l'identification
user_id L'identifiant de l'utilisateur

Exemple

http://greenvelvet.alwaysdata.net/kwick/logout/46efaa193f9a7d8dace33a94e9397842/2

Réponse

{"kwick":
    {"version":"0.12",
     "completed_in":"0.026",
     "status":"ok"},
"result":{"status":"done",
          "message":"already logged out"}
}
            
Paramêtre Valeurs
status done, failure
message (optionel) commentaire

/user/logged/token

Accès

Privé

Description

Renvoie la liste des utilisateurs loggés

Paramêtres

Nom Description
token Le jeton de session délivré lors de l'identification

Exemple

http://greenvelvet.alwaysdata.net/kwick/api/user/logged/46efaa193f9a7d8dace33a94e9397842

Réponse

{"kwick":
    {"version":"0.12",
     "completed_in":"0.026",
     "status":"ok"},
"result":{"status":"done",
          "user":["joe","lisa","bill"]}
}
            
Paramêtre Valeurs
status done, failure
user tableau des noms des utilisateurs loggés

/say/token/user_id/message

Accès

Privé

Description

Poster un message

Paramêtres

Nom Description
token Le jeton de session délivré lors de l'identification
user_id l'identifiant de l'auteur
message le message posté.

Important Le message doit être encodé pour l'url (fonction encodeURI)

Note Le message doit faire 140 caractères maximum.

Exemple

http://greenvelvet.alwaysdata.net/kwick/api/say/46efaa193f9a7d8dace33a94e9397842/4/premier%20message

Réponse

{"kwick":
    {"version":"0.12",
     "completed_in":"0.026",
     "status":"ok"},
"result":{"status":"done"}
}
            
Paramêtre Valeurs
status done, failure

/talk/list/token/timestamp

Accès

Privé

Description

Récupére les messages postés aprés timestamp

Paramêtres

Nom Description
token Le jeton de session délivré lors de l'identification
timestamp Signature temporelle.

Note Zero permet de récupérer tout les messages

Exemple

http://greenvelvet.alwaysdata.net/kwick/api/talk/list/46efaa193f9a7d8dace33a94e9397842/1327171160

Réponse

{"kwick":
    {"version":"0.12",
     "completed_in":"0.026",
     "status":"ok"},
"result":{"status":"done",
          "talk":[
            {"timestamp":1327171211,
             "content":"salut",
             "user_name":"bob"
            },
            {"timestamp":1327243631,
             "content":";)",
             "user_name":"bill"}
           ],
          "last_timestamp":1327243631}
}
            
Paramêtre Valeurs
status done, failure
last_timestamp signature temporelle du message le plus récent.
talk Tableau des messages. Chaque cellule comporte 3 propriétés:

timestamp
signature temporelle du message
content
contenu du message
user_name
nom de l'auteur

© Thierry Tranchina - l'Ecole Multimédia 2012