#Présentation l'API de Tawacovoiturage vous permet de récuperer des évènements ainsi que des covoiturages. vous avez le choix quand à la sortie des données ( défaut => xml ou json ) l'accès a cette API requière un token qui devra être demandé a cette adresse : loic@tawacovoiturage.fr les appels sur le service se feront a cette adresse `http://api.tawacovoiturage.fr/` ##Utilisation du token Dés lors que vous aurez un token, il vous suffira de le renseigner lors de vos appels sur l'api. le paramère pour le token est nommé `X-API-KEY` l'url finale devrait ressembler a ça `http://api.tawacovoiturage.fr/api/events/events?X-API-KEY=da39a3ee5e6b4b0d3255bfef95601890afd80709` ##Navigation a travers les résultats La pagination des pages telles que les évènements sont structurées de cette façon: - ####Json : ```json "paging": { "previous": 5, "next": 15, "per_page": 20 } ``` - ####XML : ```xml <paging> <previous>0</previous> <next>30</next> <per_page>20</per_page> </paging> ``` les paramètres affichés sont : - previous :curseur pour atteindre la page précédente - next :curseur pour atteindre la page suivante - per_page :nombre d'item par page ainsi pour l'utiliser vous devez fournir un curseur a votre url de cette façon : `http://api.tawacovoiturage.fr/api/events/event_list?cursor=10` #Les évènements ##Voir les évènements non finis par ordre de creation URL : `http://api.tawacovoiturage.fr/api/events/event_feed/format/{FORMAT}?cursor={CURSOR}` Exemple : `http://api.tawacovoiturage.fr/api/events/event_feed/format/json?cursor=10` Réponse de l'exemple : ```json { "0": { "id": "1335", "name": "Ensemble Oves", "description": "Composé de 4 musiciens et de 2 danseurs-chanteurs, l’ensemble...... et Sándor Csaba Farkas : chant,danse", "start_time": "2015-03-27 20:30:00", "end_time": "2015-03-28 20:30:00", "location": "Toulouse", "adress": "Espace Pont des demoiselles, \n63 bis avenue St Exupèry,", "free": "0", "events_category_id": "10", "events_facebook_url": "", "events_ticket_url": "http://fousdarchet.festik.net/ensemble-oves/1/fr-kawa", "creator_id": "1", "image_min": "http://fousdarchet.festik.net/download.php?t=def&fes_id=241&size=3&size=1", "image_wide": null, "counter": "0", "created": "2015-01-05 10:07:28", "modified": "2015-01-05 10:07:28" }, .................................................. "paging": { "next": 20, "total": 237 } } ``` ##Voir tout les évènements URL : `http://api.tawacovoiturage.fr/api/events/event_list/format/{FORMAT}?cursor={CURSOR}` Exemple : `http://api.tawacovoiturage.fr/api/events/event_list/format/json?cursor=10` Réponse de l'exemple : ```json { "0": { "id": "1335", "name": "Ensemble Oves", "description": "Composé de 4 musiciens et de 2 danseurs-chanteurs, l’ensemble...... et Sándor Csaba Farkas : chant,danse", "start_time": "2015-03-27 20:30:00", "end_time": "2015-03-28 20:30:00", "location": "Toulouse", "adress": "Espace Pont des demoiselles, \n63 bis avenue St Exupèry,", "free": "0", "events_category_id": "10", "events_facebook_url": "", "events_ticket_url": "http://fousdarchet.festik.net/ensemble-oves/1/fr-kawa", "creator_id": "1", "image_min": "http://fousdarchet.festik.net/download.php?t=def&fes_id=241&size=3&size=1", "image_wide": null, "counter": "0", "created": "2015-01-05 10:07:28", "modified": "2015-01-05 10:07:28" }, .................................................. "paging": { "previous": 7, "next": 13, "per_page": 3 } } ``` ##Voir les évènements par catégorie URL : `http://api.tawacovoiturage.fr/api/events/event_list/format/{FORMAT}?cursor={CURSOR}&cat={ID_CAT}` Exemple : `http://api.tawacovoiturage.fr/api/events/event_list/format/json?cursor=0&cat=5` Réponse de l'exemple : ```json { "0": { "id": "612", "name": "PARIS MANGA", "description": "18 ème festival de Paris Manga !", "start_time": "2014-10-10 12:00:00", "end_time": "2014-10-16 12:00:00", "location": "Paris", "adress": "Hall 2.1, Paris Porte de versailles", "free": "0", "events_category_id": "5", "events_facebook_url": "http://facebook.com/pages/PARIS-MANGA-OFFICIEL-PAGE/123629761008579", "events_ticket_url": "", "creator_id": "1", "image_min": "http://tawacovoiturage.fr/assets/events/20481-2.jpg", "image_wide": null, "counter": "0", "created": "0000-00-00 00:00:00", "modified": "2014-10-16 16:09:00" }, .................................................. "paging": { "previous": 0, "next": 20, "per_page": 20 } } ``` ##Voir un évènement URL : `http://api.tawacovoiturage.fr/api/events/event/format/{FORMAT}?id={ID}` Exemple : `http://api.tawacovoiturage.fr/api/events/event/format/json?id=631` Réponse de l'exemple : ```json { "id": "631", "name": "Planche(s) Contact", "description": "La Planche Contact est née de l?envie de continuer à ....... dans le présent et qui se projette dans l?avenir.", "start_time": "2014-10-10 12:00:00", "end_time": "2014-11-30 12:00:00", "location": "Deauville", "adress": "n.c", "free": "0", "events_category_id": "10", "events_facebook_url": "http://www.facebook.com/profile.php?id=1045725028", "events_ticket_url": "", "creator_id": "1", "image_min": "", "image_wide": null, "counter": "8", "created": "0000-00-00 00:00:00", "modified": "2014-12-13 03:27:27" } ``` #Les covoiturages ##Voir les covoiturages URL : `http://api.tawacovoiturage.fr/api/carpoolings/carpooling_list/format/{FORMAT}?cursor={CURSOR}` Exemple : `http://api.tawacovoiturage.fr/api/carpoolings/carpooling_list/format/json?cursor=20` Réponse de l'exemple : ```json { "0": { "id": "29", "departure_city": "Ertertec Informática - Avenida 25 de Julho, Flores da Cunha - Rio Grande do Sul, Brésil", "departure_adress": "65 cours de la marne", "departure_datetime": "2014-11-07 01:10:00", "flexible_id": "2", "available_seats": "1", "reserved_seats": "0", "price_per_place": "15", "title": "Ertertec Informática - Avenida 25 de Julho, Flores da Cunha - Rio Grande do Sul, Brésil -> Festival Koalition", "description": "rtretertertertertertertrettre", "bagage_id": "1", "smokers": "0", "animals": "0", "troc": "0", "id_events": "23", "id_user": "3", "counter": "0", "created": "2014-10-27 16:43:59", "modified": "2014-10-27 16:43:59" }, ....................................... "paging": { "previous": 0, "next": 40, "per_page": 20 } } ``` ##Voir les covoiturages d'un évènement URL : `http://api.tawacovoiturage.fr/api/carpoolings/carpooling_event_list/format/{FORMAT}?id={ID}&cursor={CURSOR}` Exemple : `http://api.tawacovoiturage.fr/api/carpoolings/carpooling_event_list/format/json?id=720&cursor=0` Réponse de l'exemple : ```json { "0": { "id": "41", "departure_city": "Toulouse, France", "departure_adress": "Rue du miral", "departure_datetime": "2014-11-29 03:20:00", "flexible_id": "3", "available_seats": "1", "reserved_seats": "0", "price_per_place": "23", "title": "Toulouse, France -> WORLD TRANCE FESTIVAL OPEN AIR // 03-04-05 JUILLET 2015 // CAP DECOUVERTE", "description": "zefjezrjkfnekrjfnkejrnferfef", "bagage_id": "1", "smokers": "0", "animals": "0", "troc": "0", "id_events": "720", "id_user": "9", "counter": "353", "created": "2014-11-23 20:01:46", "modified": "2014-12-30 13:45:06" }, ...................... "paging": { "previous": 0, "next": 10, "per_page": 10 } } ``` ##Voir un covoiturage URL : `http://api.tawacovoiturage.fr/api/carpoolings/carpooling/format/{FORMAT}?id={ID}` Exemple : `http://api.tawacovoiturage.fr/api/carpoolings/carpooling/format/json?id=25` Réponse de l'exemple : ```json { "id": "25", "departure_city": "Toulouse, France", "departure_adress": "Iekskfjdisidjeisie", "departure_datetime": "2014-11-15 04:50:00", "flexible_id": "4", "available_seats": "20", "reserved_seats": "5", "price_per_place": "10", "title": "Toulouse, France -> Festival d'Automne à Paris", "description": "Idjdjdhfjdjfjdkd", "bagage_id": "3", "smokers": "1", "animals": "1", "troc": "1", "id_events": "280", "id_user": "3", "counter": "15", "created": "2014-10-24 19:41:51", "modified": "2014-11-14 22:02:30" } ``` #Catégories ##Voir les catégories URL : `http://api.tawacovoiturage.fr/api/categories/list/format/{FORMAT}` Exemple : `http://api.tawacovoiturage.fr/api/categories/list/format/json` Réponse de l'exemple : ```json [ { "id": "1", "name": "Festivals", "description": "Catégorie regroupant tout les festivals" }, ............. { "id": "12", "name": "Cinéma", "description": "Cinéma" } ] ```