Api Textbox

mis à jour

Cette Api est fournie à titre expérimental et gracieux, pour le moment elle ne fait l'objet d'aucun contrat ni d'aucune garantie. L'interface Textbox utilise quasiment les mêmes points d'accès et données que vous pouvez explorer dans la console de votre navigateur.

Documentation de l'Api Textbox

Textbox vous propose une APi pour créer, administrer et récupérer vos travaux et vos tâches.

https://api.textbox.live/

Par défaut l'Api répond au format JSON, vous pouvez obtenir une réponse au format XML en ajoutant l'extension .xml à l'url : https://api.textbox.live/questions.xml?lng=fr

Limites

L'APi Textbox accepte un certain nombre de requêtes par heure. En cas de dépassement de cette limite ou en cas de saturation du service un entête de code 503 est renvoyé. Nous vous remercions par avance de modérer vos interrogations de l'Api afin de ne pas entraîner de surcharge inutile du service.

Authentification

OAuth 2.0

Nous utilisons le protocole oAuth, vous pouvez créer des identifiants d'application et obtenir rapidement un access_token dans l'interface.

curl -H "Authorization: Bearer << access_token >>" https://api.textbox.live/profileapi.get('/profile',function(rez){log(rez);})

Pour simplifier l'usage de notre Api, nous n'utilisons pas la refresh token.

Pour obtenir une autorisation utilisez l'url https://textbox.live/auth et pour recevoir l'access_token https://textbox.live/token.

Classique

Vous pouvez aussi vous connecter à Textbox par la méthode classique en conservant le cookie de session, pour ce faire utilisez l'url /profile :

curl -d "{'action':'login','email':'email@ndd.tld','password':'azerty'}" POST https://api.textbox.live/profile

Méthode

Pour accéder à l'Api Textbox vous pouvez utiliser des requêtes GET ou POST.

Données

Les données transmissent par POST doivent être encodées sous forme de JSON.

curl -d "{'action':'test', 'key':'value'}" -H "Authorization: Bearer << access_token >>" POST https://api.textbox.live/

En cas de nécessité, vous pouvez envoyer les données dans le paramètre « data » au lieu d'envoyé les données sans destination : -d "data={'key':'value'}".

Dans la console JavaScript ça donne :

api.post('/test',{ 'action':'test', 'key':'value' },function(rez){ log(rez); });

Pagination

Lorsque que vous récupérez des informations sous forme de liste, vous obtenez les résultats dans la clé « result » et la pagination dans l'entrée « paging ».

{ "result": [ (...) ], "paging": { "next": "7rXSvQrP7nLSwbtaiOpS3aKeUcqtoh596wFnT2EtfStZP9cIWR", "prev": "tOpsksuDgBtEWYOIbWU9O5nUHm4Ll1z184FPk9iuFCcuqKA3", "limit": 20 } }

Selon que vous souhaitiez les pages suivantes ou précédentes vous devez transmettre respectivement les valeurs « next » ou « prev » dans le paramètre d'url https://api.textbox.live/bills?paging=7rXSvQrP7nLSwbtaiOpS3aKeUcqtoh596wFnT2EtfStZP9cIWR