La partie texte de l’API Hellotipi utilise la même structure et le même comportement que l’API Twitter, en vue d’offrir une compatibilité avec des applications Twitter existantes.
Les fonctions disponibles permettent de travailler uniquement sur les messages publics et privés d’Hellotipi. Elles sont les suivantes :
- statuses/family_timeline renvoie la liste des messages publics d’un site de famille
- statuses/friends_timeline renvoie la liste des messages publics de tous les sites de famille
- statuses/user_timeline renvoie la liste des messages publics envoyés par l’utilisateur authentifié
- statuses/show affiche un message
- statuses/update poste un nouveau message
- statuses/replies est un alias de statuses/friends_timeline
- statuses/destroy efface un message
- statuses/friends affiche la liste des contacts
- statuses/followers est un alias de statuses/friends
- statuses/featured affiche la liste des contacts actuellement connectés sur le site Hellotipi
- user/show affiche les informations d’un contact
- direct_messages renvoie la liste des messages privés
- direct_messages/sent renvoie la liste des messages privés envoyés par l’utilisateur authentifié
- direct_messages/new poste un nouveau message privé
- direct_messages/destroy efface un message privé
- account/verify_credentials teste si l’authentification est valide
- account/end_session détruit la session courante
- account/rate_limit_status affiche le nombre de requêtes autorisées restantes sur le serveur API pour l’heure en cours
- help/test permet d’effectuer un test
Les fonctions suivantes existent mais ne sont pas utilisées et renvoient une chaine vide :
- statuses/public_timeline
- friendships/create
- friendships/destroy
- friendships/exists
- account/update_location
- account/update_delivery_device
- favorites
- favorites/create
- favorites/destroy
- notifications/follow
- notifications/leave
- blocks/create
- blocks/destroy
- help/downtime_schedule
statuses/family_timeline
Description
Permet de récupérer la liste des 20 derniers messages publics d’un site de famille de l’utilisateur authentifié.
Cette fonction n’est pas “ISO Twitter”.
URL
http://apitxt.hellotipi.com/statuses/family_timeline.format
Méthode(s)
GET
Paramètre(s)
- site = char (nom du site de famille: obligatoire)
+ 1 paramètre optionnel par requête
- since = date (limite les résultats aux messages postés après cette date ; le même comprotement peut être obtenu en spécifiant l’entête HTTP If-Modified-Since dans la requête. Date au format RFC 2822, optionnel)
- since_id = int (renvoie les messages postés après le message since_id, optionnel)
- count = int (nombre de messages à renvoyer, 20 par défaut, 200 max, optionnel)
- page = int (numéro de la page demandée, optionnel)
Réponse
Tableau contenant pour chaque message un tableau de la forme :
- favorited = bool (non utilisé)
- text = char (texte du message)
- in_reply_to_user_id = int (non utilisé)
- created_at = date (date du message au format suivant : Tue Sep 16 11:38:39 +0200 2008 (en PHP : date(D M j H:i:s O Y))
- created_at_iso8601 = date (date du message au format ISO 8601)
- truncated = bool (non utilisé)
- source = char (url du site de famille)
- id = int (id du message)
- user[id] = int (identifiant de l’utilisateur)
- user[name] = char (nom complet de l’utilisateur)
- user[screen_name] = char (identifiant de l’utilisateur suivi de sa famille login#famille)
- user[location] = char (non utilisé)
- user[description] = char (non utilisé)
- user[profile_image_url] = char (url de l’image du profil de l’utilisateur)
- user[url] = char (url du profil de l’utilisateur)
- user[protected] = bool (non utilisé)
- user[followers_count] = int (non utilisé)
- site[name] = char (identifiant du site)
- site[title] = char (titre du site)
Exemple
http://apitxt.hellotipi.com/statuses/family_timeline.format?site=nomdefamille
Retourne la liste des message publics du site nomdefamille.
statuses/friends_timeline
Description
Permet de récupérer la liste des 20 derniers messages publics de l’utilisateur authentifié toutes familles confondues.
URL
http://apitxt.hellotipi.com/statuses/friends_timeline.format
Méthode(s)
GET
Paramètre(s)
1 paramètre optionnel par requête
- since = date (limite les résultats aux messages postés après cette date ; le même comprotement peut être obtenu en spécifiant l’entête HTTP If-Modified-Since dans la requête. Date au format RFC 2822, optionnel)
- since_id = int (renvoie les messages postés après le message since_id, optionnel)
- count = int (nombre de messages à renvoyer, 20 par défaut, 200 max, optionnel)
- page = int (numéro de la page demandée, optionnel)
Réponse
Tableau contenant pour chaque message un tableau de la forme :
- favorited = bool (non utilisé)
- text = char (texte du message)
- in_reply_to_user_id = int (non utilisé)
- created_at = date (date du message au format suivant : Tue Sep 16 11:38:39 +0200 2008 (en PHP : date(D M j H:i:s O Y))
- created_at_iso8601 = date (date du message au format ISO 8601)
- truncated = bool (non utilisé)
- source = char (url du site de famille)
- id = int (id du message)
- user[id] = int (identifiant de l’utilisateur)
- user[name] = char (nom complet de l’utilisateur)
- user[screen_name] = char (identifiant de l’utilisateur suivi de sa famille login#famille)
- user[location] = char (non utilisé)
- user[description] = char (non utilisé)
- user[profile_image_url] = char (url de l’image du profil de l’utilisateur)
- user[url] = char (url du profil de l’utilisateur)
- user[protected] = bool (non utilisé)
- user[followers_count] = int (non utilisé)
- site[name] = char (identifiant du site)
- site[title] = char (titre du site)
Exemple
http://apitxt.hellotipi.com/statuses/friends_timeline.format?since_id=Tue%2C+27+Mar+2007+02%3A55%3A48+GMT
Retourne la liste des message publics des sites de toutes vos familles depuis le 27 mars 2007.
statuses/user_timeline
Description
Permet de récupérer la liste des 20 derniers messages envoyés d’un utilisateur donné (par défaut l’utilisateur authentifié).
URL
http://apitxt.hellotipi.com/statuses/user_timeline.format
Méthode(s)
GET
Paramètre(s)
id (optionnel)+ 1 autre paramètre optionnel par requête
- id = int ou char (l’ID ou le login de l’utilisateur d’une de vos familles pour lequel on souhaite avoir la liste des messages, optionnel)
- since = date (limite les résultats aux messages postés après cette date ; le même comprotement peut être obtenu en spécifiant l’entête HTTP If-Modified-Since dans la requête. Date au format RFC 2822, optionnel)
- since_id = date (renvoie les messages postés après le message since_id, optionnel)
- count = int (nombre de messages à renvoyer, 20 par défaut, 200 max, optionnel)
- page = int (numéro de la page demandée, optionnel)
Réponse
Tableau contenant pour chaque message un tableau de la forme :
- favorited = bool (non utilisé)
- text = char (texte du message)
- in_reply_to_user_id = int (non utilisé)
- created_at = date (date du message au format suivant : Tue Sep 16 11:38:39 +0200 2008 (en PHP : date(D M j H:i:s O Y))
- created_at_iso8601 = date (date du message au format ISO 8601)
- truncated = bool (non utilisé)
- source = char (url du site de famille)
- id = int (id du message)
- user[id] = int (identifiant de l’utilisateur)
- user[name] = char (nom complet de l’utilisateur)
- user[screen_name] = char (identifiant de l’utilisateur suivi de sa famille login#famille)
- user[location] = char (non utilisé)
- user[description] = char (non utilisé)
- user[profile_image_url] = char (url de l’image du profil de l’utilisateur)
- user[url] = char (url du profil de l’utilisateur)
- user[protected] = bool (non utilisé)
- user[followers_count] = int (non utilisé)
- site[name] = char (identifiant du site)
- site[title] = char (titre du site)
Exemple
http://apitxt.hellotipi.com/statuses/user_timeline.format?id=unutilisateur ou
http://apitxt.hellotipi.com/statuses/user_timeline/unutilisateur.format
Retourne la liste des messages envoyés par l’utilisateur unutilisateur.
statuses/show
Description
Permet de récupérer un message donné.
URL
http://apitxt.hellotipi.com/statuses/show/id.format
Méthode(s)
GET
Paramètre(s)
id requis
- id = int (l’ID du message à récupérer, requis)
Réponse
Tableau de la forme :
- favorited = bool (non utilisé)
- text = char (texte du message)
- in_reply_to_user_id = int (non utilisé)
- created_at = date (date du message au format suivant : Tue Sep 16 11:38:39 +0200 2008 (en PHP : date(D M j H:i:s O Y))
- created_at_iso8601 = date (date du message au format ISO 8601)
- truncated = bool (non utilisé)
- source = char (url du site de famille)
- id = int (id du message)
- user[id] = int (identifiant de l’utilisateur)
- user[name] = char (nom complet de l’utilisateur)
- user[screen_name] = char (identifiant de l’utilisateur suivi de sa famille login#famille)
- user[location] = char (non utilisé)
- user[description] = char (non utilisé)
- user[profile_image_url] = char (url de l’image du profil de l’utilisateur)
- user[url] = char (url du profil de l’utilisateur)
- user[protected] = bool (non utilisé)
- user[followers_count] = int (non utilisé)
Exemple
http://apitxt.hellotipi.com/statuses/show/1516518915616.format
Retourne le message 1516518915616.
statuses/update
Description
Permet de poster un nouveau message public ou privé dont l’expéditeur est l’utilisateur authentifié.
En début de message, vous devez fournir le nom du site de famille sur lequel vous souhaitez poster, précéder du signe “@”.
Les exemples suivants envoient un message public sur la famille “mafamille” :
- @mafamille mon message
- @unepersonne#mafamille mon message
- @unepersonne mon message : ne fonctionnera que si vous n’avez qu’un site de famille en commun avec le destinataire
Pour envoyer un message privé avec cette fonction, vous pouvez précéder le message du nom de la personne et de sa famille précéder de “d “.
Les exemples suivants envoient un message privé à la personne “unepersonne” sur la famille “mafamille” :
- d unepersonne#mafamille mon message
- d unepersonne mon message : ne fonctionnera que si vous n’avez qu’un site de famille en commun avec le destinataire
La commande spéciale @all (ou @tous) enverra un message public sur tous vos sites de familles (ex : “@all mon message”)
URL
http://apitxt.hellotipi.com/statuses/update
Méthode(s)
POST ou GET
Paramètre(s)
- status = char (texte du message, 500 caractères maxi, requis)
- in_reply_to_status_id = char (non utilisé, optionnel)
Réponse
Renvoie le message inséré en cas de succès, ou une page 403 spécifiant l’erreur en cas d’échec ; pour un message public, dans un tableau de la forme :
- favorited = bool (non utilisé)
- text = char (texte du message)
- in_reply_to_user_id = int (non utilisé)
- created_at = date (date du message au format suivant : Tue Sep 16 11:38:39 +0200 2008 (en PHP : date(D M j H:i:s O Y))
- truncated = bool (non utilisé)
- source = char (url du site de famille)
- id = int (id du message)
- user[id] = int (identifiant de l’utilisateur)
- user[name] = char (nom complet de l’utilisateur)
- user[screen_name] = char (identifiant de l’utilisateur suivi de sa famille login#famille)
- user[location] = char (non utilisé)
- user[description] = char (non utilisé)
- user[profile_image_url] = char (url de l’image du profil de l’utilisateur)
- user[url] = char (url du profil de l’utilisateur)
- user[protected] = bool (non utilisé)
- user[followers_count] = int (non utilisé)
Pour un message privé, dans un tableau de la forme :
- text = char (texte du message)
- sender_id = int (ID de l’expéditeur)
- recipient_id = int (ID du destinataire)
- created_at = date (date du message au format suivant : Tue Sep 16 11:38:39 +0200 2008 (en PHP : date(D M j H:i:s O Y))
- sender_screen_name = char (login de l’expéditeur suivi de sa famille)
- recipient_screen_name = char (login du destinataire suivi de sa famille)
- sender[id] = int (ID de l’expéditeur)
- sender[name] = char (nom complet de l’expéditeur)
- sender[screen_name] = char (login de l’expéditeur suivi de sa famille)
- sender[location] = char (non utilisé)
- sender[description] = char (non utilisé)
- sender[profile_image_url] = char (url de l’image du profil de l’expéditeur)
- sender[url] = char (url du profil de l’expéditeur)
- sender[protected] = bool (non utilisé)
- sender[followers_count] = int (non utilisé)
- recipient[id] = int (ID du destinataire)
- recipient[name] = char (nom complet du destinataire)
- recipient[screen_name] = char (login du destinataire suivi de sa famille)
- recipient[location] = char (non utilisé)
- recipient[description] = char (non utilisé)
- recipient[profile_image_url] = char (url de l’image du profil du destinataire)
- recipient[url] = char (url du profil du destinataire)
- recipient[protected] = bool (non utilisé)
- recipient[followers_count] = int (non utilisé)
statuses/replies
Description
statuses/replies est un alias statuses/friends_timeline
statuses/destroy
Description
Permet d’effacer un message donné.
URL
http://apitxt.hellotipi.com/statuses/destroy/id.format
Méthode(s)
POST, DELETE
Paramètre(s)
id requis
- id = int (l’ID du message à effacer, requis)
Réponse
Renvoie une erreur 404 si le message n’existe pas, ou le message effacé en cas de succès dans un tableau de la forme :
- favorited = bool (non utilisé)
- text = char (texte du message)
- in_reply_to_user_id = int (non utilisé)
- created_at = date (date du message au format suivant : Tue Sep 16 11:38:39 +0200 2008 (en PHP : date(D M j H:i:s O Y))
- truncated = bool (non utilisé)
- source = char (url du site de famille)
- id = int (id du message)
- user[id] = int (identifiant de l’utilisateur)
- user[name] = char (nom complet de l’utilisateur)
- user[screen_name] = char (identifiant de l’utilisateur suivi de sa famille login#famille)
- user[location] = char (non utilisé)
- user[description] = char (non utilisé)
- user[profile_image_url] = char (url de l’image du profil de l’utilisateur)
- user[url] = char (url du profil de l’utilisateur)
- user[protected] = bool (non utilisé)
- user[followers_count] = int (non utilisé)
Exemple
http://apitxt.hellotipi.com/statuses/destroy/1516518915616.format
Efface le message 1516518915616.
statuses/friends
Description
Retourne la liste des contacts de toutes les familles d’une personne donnée (par défaut ceux de l’utilisateur authentifié).
URL
http://apitxt.hellotipi.com/statuses/friends/id.format
Méthode(s)
GET
Paramètre(s)
- id = int ou char (l’ID ou le login de l’utilisateur pour lequel on souhaite récupérer les contacts, optionnel)
Réponse
Tableau contenant pour chaque contact un tableau de la forme :
- id = int (identifiant de l’utilisateur)
- name = char (nom complet de l’utilisateur)
- screen_name = char (identifiant de l’utilisateur suivi de sa famille login#famille)
- location = char (non utilisé)
- description = char (non utilisé)
- profile_image_url = char (url de l’image du profil de l’utilisateur)
- url = char (url du profil de l’utilisateur)
- protected = bool (non utilisé)
- followers_count = int (non utilisé)
Exemple
http://apitxt.hellotipi.com/statuses/friends/915616.format
Retourne les contacts de l’utilisateur 915616.
statuses/family_friends
Description
Retourne la liste des contacts d’une famille de l’utilisateur authentifié.
URL
http://apitxt.hellotipi.com/statuses/family_friends.format?site=nomdefamille
Méthode(s)
GET
Paramètre(s)
- site = char (nom du site pour lequel on souhaite récupérer les contacts, obligatoire)
Réponse
Tableau contenant pour chaque contact un tableau de la forme :
- id = int (identifiant de l’utilisateur)
- name = char (nom complet de l’utilisateur)
- screen_name = char (identifiant de l’utilisateur suivi de sa famille login#famille)
- profile_image_url = char (avatar de l’utilisateur)
- url = char (url du profil)
- email = char (email de l’utilisateur) *
- birthday = char (date d’anniversaire de l’utilisateur)
- address_1 = char (adresse de l’utilisateur) *
- address_2 = char (adresse de l’utilisateur, seconde ligne) *
- zip = char (code postal de l’utilisateur)
- state = char (état/province de l’utilisateur)
- city = char (ville de l’utilisateur)
- country_name = char (pays de l’utilisateur)
- phone_1 = char (numéro de téléphone de l’utilisateur) *
- phone_2 = char (second numéro de téléphone de l’utilisateur) *
* Restrictions
Les informations suivies d’un * nécessitent l’utilisation d’une clée afin de protéger ces données sensibles
Exemple
http://apitxt.hellotipi.com/statuses/family_friends.format?site=nomdefamille
Retourne les contacts du site nomdefamille.
statuses/followers
Description
statuses/followers est un alias statuses/friends
statuses/featured
Description
Pour l’utilisateur authentifié, retourne la liste de ses contacts de toutes ses familles étant actuellement connectés sur www.hellotipi.com.
URL
http://apitxt.hellotipi.com/statuses/featured/id.format
Méthode(s)
GET
Paramètre(s)
Aucun
Réponse
Tableau contenant pour chaque contact un tableau de la forme :
- id = int (identifiant de l’utilisateur)
- name = char (nom complet de l’utilisateur)
- screen_name = char (identifiant de l’utilisateur suivi de sa famille login#famille)
- location = char (non utilisé)
- description = char (non utilisé)
- profile_image_url = char (url de l’image du profil de l’utilisateur)
- url = char (url du profil de l’utilisateur)
- protected = bool (non utilisé)
- followers_count = int (non utilisé)
Exemple
http://apitxt.hellotipi.com/statuses/featured.format
Retourne les contacts en ligne de l’utilisateur authentifié.
user/show
Description
Permet de récupérer les informations d’un utilisateur donné (par défaut l’utilisateur authentifié) si celui-ci est dans vos contacts.
URL
http://apitxt.hellotipi.com/user/show/id.format
Méthode(s)
GET
Paramètre(s)
- id = int ou char (l’ID ou le login de l’utilisateur pour lequel on souhaite récupérer les informations, optionnel)
- email = char (l’email de l’utilisateur pour lequel on souhaite récupérer les informations, optionnel)
Réponse
Tableau de la forme :
- id = int (identifiant de l’utilisateur)
- name = char (nom complet de l’utilisateur)
- screen_name = char (identifiant de l’utilisateur)
- location = char (non utilisé)
- description = char (non utilisé)
- profile_image_url = char (url de l’image du profil de l’utilisateur)
- url = char (non utilisé)
- protected = bool (non utilisé)
- followers_count = int (non utilisé)
- profile_background_color = char (non utilisé)
- profile_text_color = char (non utilisé)
- profile_link_color = char (non utilisé)
- profile_sidebar_fill_color = char (non utilisé)
- profile_sidebar_border_color = char (non utilisé)
- friends_count = int (non utilisé)
- created_at = date (non utilisé)
- favourites_count = bool (non utilisé)
- utc_offset = char (non utilisé)
- time_zone = char (non utilisé)
- following = bool (non utilisé)
- notifications = bool (non utilisé)
- statuses_count = int (non utilisé)
- status = char (non utilisé)
Exemple
http://apitxt.hellotipi.com/user/show/unutilisateur.format
Retourne les informations de l’utilisateur unutilisateur.
direct_messages
Description
Permet de récupérer la liste des 20 derniers messages privés de l’utilisateur authentifié toutes familles confondues.
URL
http://apitxt.hellotipi.com/direct_messages.format
Méthode(s)
GET
Paramètre(s)
1 paramètre optionnel par requête.
- since = date (limite les résultats aux messages postés après cette date ; le même comprotement peut être obtenu en spécifiant l’entête HTTP If-Modified-Since dans la requête. Date au format RFC 2822, optionnel)
- since_id = date (renvoie les messages postés après le message since_id, optionnel)
- page = int (numéro de la page demandée, optionnel)
Réponse
Tableau contenant pour chaque message un tableau de la forme :
- text = char (texte du message)
- sender_id = int (ID de l’expéditeur)
- recipient_id = int (ID du destinataire)
- created_at = date (date du message au format suivant : Tue Sep 16 11:38:39 +0200 2008 (en PHP : date(D M j H:i:s O Y))
- sender_screen_name = char (login de l’expéditeur suivi de sa famille)
- recipient_screen_name = char (login du destinataire suivi de sa famille)
- sender[id] = int (ID de l’expéditeur)
- sender[name] = char (nom complet de l’expéditeur)
- sender[screen_name] = char (login de l’expéditeur suivi de sa famille)
- sender[location] = char (non utilisé)
- sender[description] = char (non utilisé)
- sender[profile_image_url] = char (url de l’image du profil de l’expéditeur)
- sender[url] = char (url du profil de l’expéditeur)
- sender[protected] = bool (non utilisé)
- sender[followers_count] = int (non utilisé)
- recipient[id] = int (ID du destinataire)
- recipient[name] = char (nom complet du destinataire)
- recipient[screen_name] = char (login du destinataire suivi de sa famille)
- recipient[location] = char (non utilisé)
- recipient[description] = char (non utilisé)
- recipient[profile_image_url] = char (url de l’image du profil du destinataire)
- recipient[url] = char (url du profil du destinataire)
- recipient[protected] = bool (non utilisé)
- recipient[followers_count] = int (non utilisé)
Exemple
http://apitxt.hellotipi.com/direct_messages.format?since_id=Tue%2C+27+Mar+2007+02%3A55%3A48+GMT
Retourne la liste des message privés des sites de toutes vos familles depuis le 27 mars 2007.
direct_messages/sent
Description
Permet de récupérer la liste des 20 derniers messages privés envoyés par l’utilisateur authentifié toutes familles confondues.
URL
http://apitxt.hellotipi.com/direct_messages/sent.format
Méthode(s)
GET
Paramètre(s)
1 paramètre optionnel par requête.
- since = date (limite les résultats aux messages postés après cette date ; le même comprotement peut être obtenu en spécifiant l’entête HTTP If-Modified-Since dans la requête. Date au format RFC 2822, optionnel)
- since_id = date (renvoie les messages postés après le message since_id, optionnel)
- page = int (numéro de la page demandée, optionnel)
Réponse
Tableau contenant pour chaque message un tableau de la forme :
- text = char (texte du message)
- sender_id = int (ID de l’expéditeur)
- recipient_id = int (ID du destinataire)
- created_at = date (date du message au format suivant : Tue Sep 16 11:38:39 +0200 2008 (en PHP : date(D M j H:i:s O Y))
- sender_screen_name = char (login de l’expéditeur suivi de sa famille)
- recipient_screen_name = char (login du destinataire suivi de sa famille)
- sender[id] = int (ID de l’expéditeur)
- sender[name] = char (nom complet de l’expéditeur)
- sender[screen_name] = char (login de l’expéditeur suivi de sa famille)
- sender[location] = char (non utilisé)
- sender[description] = char (non utilisé)
- sender[profile_image_url] = char (url de l’image du profil de l’expéditeur)
- sender[url] = char (url du profil de l’expéditeur)
- sender[protected] = bool (non utilisé)
- sender[followers_count] = int (non utilisé)
- recipient[id] = int (ID du destinataire)
- recipient[name] = char (nom complet du destinataire)
- recipient[screen_name] = char (login du destinataire suivi de sa famille)
- recipient[location] = char (non utilisé)
- recipient[description] = char (non utilisé)
- recipient[profile_image_url] = char (url de l’image du profil du destinataire)
- recipient[url] = char (url du profil du destinataire)
- recipient[protected] = bool (non utilisé)
- recipient[followers_count] = int (non utilisé)
Exemple
http://apitxt.hellotipi.com/direct_messages.format?since_id=Tue%2C+27+Mar+2007+02%3A55%3A48+GMT
Retourne la liste des message privés envoyés depuis le 27 mars 2007.
direct_messages/new
Description
Permet de poster un nouveau message privé dont l’expéditeur est l’utilisateur authentifié.
URL
http://apitxt.hellotipi.com/direct_messages/sent.format
Méthode(s)
POST
Paramètre(s)
user et text requis.
- user = int ou char (ID ou login du destinataire du message, requis)
- text = char (texte du message à envoyer, 500 caractères maxi, requis)
Réponse
Renvoie le message inséré en cas de succès dans un tableau de la forme :
- text = char (texte du message)
- sender_id = int (ID de l’expéditeur)
- recipient_id = int (ID du destinataire)
- created_at = date (date du message au format suivant : Tue Sep 16 11:38:39 +0200 2008 (en PHP : date(D M j H:i:s O Y))
- sender_screen_name = char (login de l’expéditeur suivi de sa famille)
- recipient_screen_name = char (login du destinataire suivi de sa famille)
- sender[id] = int (ID de l’expéditeur)
- sender[name] = char (nom complet de l’expéditeur)
- sender[screen_name] = char (login de l’expéditeur suivi de sa famille)
- sender[location] = char (non utilisé)
- sender[description] = char (non utilisé)
- sender[profile_image_url] = char (url de l’image du profil de l’expéditeur)
- sender[url] = char (url du profil de l’expéditeur)
- sender[protected] = bool (non utilisé)
- sender[followers_count] = int (non utilisé)
- recipient[id] = int (ID du destinataire)
- recipient[name] = char (nom complet du destinataire)
- recipient[screen_name] = char (login du destinataire suivi de sa famille)
- recipient[location] = char (non utilisé)
- recipient[description] = char (non utilisé)
- recipient[profile_image_url] = char (url de l’image du profil du destinataire)
- recipient[url] = char (url du profil du destinataire)
- recipient[protected] = bool (non utilisé)
- recipient[followers_count] = int (non utilisé)
direct_messages/destroy
Description
Permet d’effacer un message privé donné.
URL
http://apitxt.hellotipi.com/direct_messages/destroy/id.format
Méthode(s)
POST, DELETE
Paramètre(s)
id requis
- id = int (l’ID du message à effacer, requis)
Réponse
Renvoie une erreur 404 si le message n’existe pas, ou le message effacé en cas de succès dans un tableau de la forme :
- text = char (texte du message)
- sender_id = int (ID de l’expéditeur)
- recipient_id = int (ID du destinataire)
- created_at = date (date du message au format suivant : Tue Sep 16 11:38:39 +0200 2008 (en PHP : date(D M j H:i:s O Y))
- sender_screen_name = char (login de l’expéditeur suivi de sa famille)
- recipient_screen_name = char (login du destinataire suivi de sa famille)
- sender[id] = int (ID de l’expéditeur)
- sender[name] = char (nom complet de l’expéditeur)
- sender[screen_name] = char (login de l’expéditeur suivi de sa famille)
- sender[location] = char (non utilisé)
- sender[description] = char (non utilisé)
- sender[profile_image_url] = char (url de l’image du profil de l’expéditeur)
- sender[url] = char (url du profil de l’expéditeur)
- sender[protected] = bool (non utilisé)
- sender[followers_count] = int (non utilisé)
- recipient[id] = int (ID du destinataire)
- recipient[name] = char (nom complet du destinataire)
- recipient[screen_name] = char (login du destinataire suivi de sa famille)
- recipient[location] = char (non utilisé)
- recipient[description] = char (non utilisé)
- recipient[profile_image_url] = char (url de l’image du profil du destinataire)
- recipient[url] = char (url du profil du destinataire)
- recipient[protected] = bool (non utilisé)
- recipient[followers_count] = int (non utilisé)
Exemple
http://apitxt.hellotipi.com/direct_messages/destroy/1516518915616.format
Efface le message 1516518915616.
account/verify_credentials
Description
Permet de se connecter au service.
URL
http://apitxt.hellotipi.com/account/verify_credentials.format
Méthode(s)
GET
Paramètre(s)
Aucun. Le login et mot de passe doivent être fourni en HTTP Basic Authentication.
Réponse
Retourne une erreur 401 en cas d’échec ou le tableau suivant en cas de succès :
- user[id] = int (ID du user)
- user[name] = char (prénom + nom du user)
- user[screen_name] = char (pseudonyme du user)
- user[profile_image_url] = char (url de l’avatar du user, url valide 1h)
account/end_session
Description
Permet de mettre un terme à la session en cours.
URL
http://apitxt.hellotipi.com/account/end_session.format
Méthode(s)
POST
Paramètre(s)
Aucun
Réponse
Aucune
account/rate_limit_status
Description
Retourne pour l’heure en cours le nombre restant d’appel à l’API disponible pour l’utilisateur authentifié.
URL
http://apitxt.hellotipi.com/account/rate_limit_status
Méthode(s)
GET
Paramètre(s)
Aucun
Réponse
Retourne une erreur 401 en cas d’échec ou le tableau suivant en cas de succès :
- remaining-hits = int (nombre de hits restants)
- hourly-limit = int (nombre limite d’appels de l’API)
- reset-time = date (date de fin de session au format ISO 8601)
- reset-time-in-seconds = int (date de fin de session au format timestamp)
help/test
Description
Permet de faire un test de connexion.
URL
http://apitxt.hellotipi.com/help/test.format
Méthode(s)
GET
Paramètre(s)
Aucun
Réponse
Retourne la chaine “ok” avec un statut HTTP 200 OK