API SHARING CITY - · PDF fileSOMMAIRE API Sharing City Bienvenue dans la ville...

17
API Sharing City - 1 ! ! !" !" !" !" API SHARING CITY Et la ville devient partage Application Programming Interface Mon P’ti Voisinage www.sharingcity.fr

Transcript of API SHARING CITY - · PDF fileSOMMAIRE API Sharing City Bienvenue dans la ville...

Page 1: API SHARING CITY -   · PDF fileSOMMAIRE API Sharing City Bienvenue dans la ville numérique ! 4 Qu’est-ce que Sharing City

API Sharing City - 1

!!

!"!"!"!"

API SHARING CITY Et la ville devient

partage Application Programming Interface

Mon P’ti Voisinage

www.sharingcity.fr

Page 2: API SHARING CITY -   · PDF fileSOMMAIRE API Sharing City Bienvenue dans la ville numérique ! 4 Qu’est-ce que Sharing City

SOMMAIRE

API Sharing City

Bienvenue dans la ville numérique ! 4 Qu’est-ce que Sharing City 5 Qu’est-ce qu’une API 7 Qu’est-ce qu’elle vous apporte 8

Cas pratiques !

Confiance numérique : valider une identité ou une adresse 13 Visibilité : partager un contenu ou un service 15 Nouveaux indicateurs : enrichir une annonce immobilière 17

Découvrir l’API

Architecture de la REST API 18 Sharing City et vous : outils utilisés dans nos exemples 19 Sharing City et vous : principe de fonctionnement 20 Sharing City et vous : envoyer un contenu à l’API 22 Sharing City et vous : valider la réponse de l’API 24 Sécurité et authentification 26 Exemple détaillé 28

!

API Sharing City - 2

Envie d’un démarrage rapide ? Regardez la dernière page !

Page 3: API SHARING CITY -   · PDF fileSOMMAIRE API Sharing City Bienvenue dans la ville numérique ! 4 Qu’est-ce que Sharing City

SOMMAIRE

Les actions disponibles

L’étendue Sharing City et les informations accessibles 34 Actions disponibles actuellement 35

Actions instantanées : Quick Get et Quick Push

Récupérer des informations sur un utilisateur ou un quartier 37 Partager votre promotion 44 Partager l’action d’un utilisateur 47 Ajouter une information de tout type 51

Partager et gérer vos contenus numériques

Inscrire votre événement sur l’agenda partagé 56 Inscrire et gérer un point d’intérêt 61 Ajouter des services et/ou objets au profil d’un utilisateur 65 Exécuter une action mutualiste avec votre plateforme 72

Commencer dès maintenant

Fiche de référence de l’API 73

API Sharing City - 3API Sharin City -

Page 4: API SHARING CITY -   · PDF fileSOMMAIRE API Sharing City Bienvenue dans la ville numérique ! 4 Qu’est-ce que Sharing City

L’API SHARING CITY

Bienvenue dans la ville numérique ! Avec « API Sharing City », entrez dans la vie de quartier, l’hyper-proximité, et la ville du partage de demain.

Nous vous donnons ainsi les clefs afin de faire interagir vos propres services avec l’ensemble des réseaux de voisinage disponibles sur www.monptivoisinage.com

Le set d’APIs décrit dans ce document est à destination des acteurs de l’habitat, de la vie publique, ainsi que de l’économie dite « collaborative ».!

!

API Sharing City - 4API Sharin City -

!

!

!"#$%&'(((()%*+Et la ville devient partage

Page 5: API SHARING CITY -   · PDF fileSOMMAIRE API Sharing City Bienvenue dans la ville numérique ! 4 Qu’est-ce que Sharing City

L’API SHARING CITY

Qu’est-ce que Sharing City ? Dans nos sociétés modernes, l’idée d’avoir des populations totalement connectées, en permanence, avec l’environnement qui les entoure devient progressivement une réalité.

Inévitablement, le mieux vivre ensemble passera de plus en plus par un « mieux connectés ensemble » et un « mieux partager ensemble ».

Corrélée à un phénomène d’inter-connectivité des individus, d’une accélération de la digitalisation des villes (services numériques, open data, objets connectés…), et de l’émergence d’une nouvelle économie du partage, cette évolution majeure de notre société va générer d’incroyables opportunités d’optimisation des ressources et d’amélioration de notre qualité de vie.

Que ce soit en terme de services (entraide variée, baby-sitting, covoiturage, partage de connaissances), de biens (voitures, denrées alimentaires, outils, jardins), ou de simples données (indice de pollution, trafic routier, horaires, open data), nos milieux urbains, quelque soit leur taille, constituent des ressources inépuisables dans lesquelles transitent une quantité infinie d’actifs, encore difficilement accessibles.

La Sharing city - traduisez la ville de partage - est née de la volonté d’accompagner cette transformation sociétale et de maintenir la population (ses préoccupations, ses besoins, ses modes de vie) au coeur de ces enjeux.

Certes le numérique a connecté les gens, certes les réseaux sociaux se sont développés et les villes se sont digitalisées, mais la coordination de ces services au profit d’un mieux vivre ensemble, d’une économie plus vertueuse et durable, doit être accélérée.

La plateforme Sharing City souhaite apporter sa pierre à l’édifice, en associant un réseau social d’hyper-proximité (Mon P’ti Voisinage) et son panel de services (tournés vers le partage, en confiance, entre les habitants d’une même zone géographique et ses acteurs de la vie locale), à une approche ouverte vers les services publics, les acteurs de l’habitat, et les acteurs de l’économie collaborative.

Cet écosystème apporte un environnement propice à la création de valeur de partage (confiance numérique, communauté de proximité, démocratie participative,

API Sharing City - 5API Sharin City -

Page 6: API SHARING CITY -   · PDF fileSOMMAIRE API Sharing City Bienvenue dans la ville numérique ! 4 Qu’est-ce que Sharing City

contextualisation), au développement durable, ainsi qu’à l’émergence de synergies entre ses différents acteurs.

Considérée comme une avancée majeure et d’ores-et-déjà taillée sur mesure pour le fonctionnement des petites comme des grandes agglomérations, la Sharing City se veut une nouvelle vision partagée de l’économie, vectrice de liens et d’intéractivités.

Avec la volonté de rendre nos villes plus intelligentes, de nombreuses collectivités ont d’ailleurs été séduites par le projet et ont rejoint l’initiative.

J’invite l’ensemble des acteurs collectifs, publics, collaboratifs, à rejoindre ce mouvement.

David Rouxel

Fondateur de Mon P’ti Voisinage & Sharing City

API Sharing City - 6

Page 7: API SHARING CITY -   · PDF fileSOMMAIRE API Sharing City Bienvenue dans la ville numérique ! 4 Qu’est-ce que Sharing City

L’API SHARING CITY

Qu’est-ce qu’une API ? Une API est un «  pont  » créé entre une plateforme (dans le cas présent Mon P’ti Voisinage) et votre propre plateforme.

Ces ponts vont vous permettre de récupérer des contenus de manière dynamique (GET) et/ou de pousser des contenus (PUSH) contextualisés, planifiés et géolocalisés.

Vous gagnerez alors en visibilité, interactivité, et richesse de service.

!

!

!

!

API Sharing City - 7

PartenairesSharing City

Collectivités, métropoles, Acteurs de la consommation collaborative, Acteurs de l’habitat. L’ensemble des réseaux de

voisinage de France.GET

PUSH

Page 8: API SHARING CITY -   · PDF fileSOMMAIRE API Sharing City Bienvenue dans la ville numérique ! 4 Qu’est-ce que Sharing City

L’API SHARING CITY

Qu’est-ce qu’elle vous apporte ?

Avec les « APIs Sharing City », entrez dans la vie de quartier, l’hyper-proximité, et la ville du partage de demain. !Nous vous fournissons les clefs afin de faire interagir vos propres services avec l’ensemble des réseaux de proximité (aussi appelés réseaux de voisinage) disponibles sur www.monptivoisinage.com

L’ensemble de ces APIs s’interface avec les réseaux de proximité, les contenus, les éléments de partage, et les utilisateurs de la plateforme Mon P’ti Voisinage (www.monptivoisinage.com)

A titre d’exemples, vous pouvez :

01! ! Utiliser le profil Mon P’ti Voisinage pour simplifier l’inscription d’un utilisateur sur votre propre service.

API Sharing City - 8API Sharin City -

Page 9: API SHARING CITY -   · PDF fileSOMMAIRE API Sharing City Bienvenue dans la ville numérique ! 4 Qu’est-ce que Sharing City

02 Vérifier l’identité ou l’adresse de domicile (physique) d’un utilisateur (numérique) partagé entre les 2 plateformes.

03 Ajouter de manière dynamique un objet ou un service dans le profil de partage de l’utilisateur (visible de sa communauté locale).

API Sharing City - 9API Sharin City -

PartenairesSharing City PUSH : un objet,

un service, un point d’intérêt ou un évènement

Page 10: API SHARING CITY -   · PDF fileSOMMAIRE API Sharing City Bienvenue dans la ville numérique ! 4 Qu’est-ce que Sharing City

04 Communiquer sur les réseaux de proximité des informations commerciales ou d’usage, de façon ciblée, à des groupes de réseau ou à l’échelle d’une ville.

API Sharing City - 10API Sharin City -

Box transportHandle with care

PartenairesSharing City

Thomas a loué une voiture à Yohann sur Koolicar. !

Achat groupé pour 5 voisins intéressés nous vous offrons 50€ !

-20% sur les locations Deways !

Page 11: API SHARING CITY -   · PDF fileSOMMAIRE API Sharing City Bienvenue dans la ville numérique ! 4 Qu’est-ce que Sharing City

05 Ajouter un « point d’intérêt » ou un évènement sur l’ensemble des réseaux de proximité ciblés.

06 Valoriser et actualiser facilement vos services sur Sharing City grâce au Push Open Data, un envoi au format souple acceptant tout type d’entrée.

API Sharing City - 11

!"!#

$%&'()'*(+,-*-.*

!"!"!"!"/0 /1

Quentin Il y a 2 minutesNous serons présent à la fête y’a t’ildes besoins particuliers ?

23 2!

Louis Il y a 3 minutesJe me propose de ramener les boissons !

Marylin Il y a 5 minutesBonjour les voisins nous avons hâte devous rencontrer en cette occasion !

API Sharin City -

PartenairesSharing City

Exemples d’évènements : Point de collecte des paniers BIO le 24 mai. Covoiturage pour le concert de Sia le 28 mai. Pensez aux élections municipales le 15 juin.

OPEN DATA

Page 12: API SHARING CITY -   · PDF fileSOMMAIRE API Sharing City Bienvenue dans la ville numérique ! 4 Qu’est-ce que Sharing City

07 Développer des synergies entre vos services et ceux de partenaires intégrés à la plateforme : le champ des possibles est infini, à vous d’être créatif !

08 Enrichir votre univers de service par des contenus provenant des réseaux de proximité, ou des « indices » générés par la plateforme (« indice d’animation de quartier » / « indice de partage entre habitants »).!

!!

!

!

!

API Sharing City - 12

Indice Sharing City 98%Les habitants collaborent etsont hyper-connectÈ s ! L' indicecollaboratif est au plus haut etle quartier est gÈ nÈ rateurd' È conomies !

!"#$%&'()#*+,$#!

"

API Sharin City -

PartenairesSharing City

PartenairesSharing City

PartenairesSharing City

Exemple :

Page 13: API SHARING CITY -   · PDF fileSOMMAIRE API Sharing City Bienvenue dans la ville numérique ! 4 Qu’est-ce que Sharing City

CAS PRATIQUES

Confiance numérique : valider une identité ou une adresse

Quand un utilisateur vous indique son identité ou son adresse on considère souvent que c’est dans son intérêt de ne pas se tromper. C’est le cas, par exemple, s’il doit recevoir un colis.

Mais qu’en est-il de ceux qui renseignent une information pour montrer «  patte blanche » puis fraudent sur votre système ?

Seriez-vous un jour mis en cause pour ne pas avoir vérifié son nom ou son adresse physique et en avoir une qui est inutilisable ?

Valider une identité ou une adresse de domicile font partie de la gamme de services proposés par notre API. Mon P’ti Voisinage utilise en effet des méthodes de vérification nombreuses et détaillées.

Autant que vous en profitiez !

API Sharing City - 13

Etape 1 - Vous placez un nouveau lien utilisateur sur votre page qui a besoin de vérifier l’adresse.

API Sharin City -

Page 14: API SHARING CITY -   · PDF fileSOMMAIRE API Sharing City Bienvenue dans la ville numérique ! 4 Qu’est-ce que Sharing City

CAS PRATIQUES

Confiance numérique : valider une identité ou une adresse

API Sharing City - 14

Etape 2 - Grâce au processus décrit dans la partie « Fonctionnement de l’API » p.32, vous appelez Sharing City…

Etape 3 - …Et recevez l’adresse de l’utilisateur confirmée et vérifiée par Mon P’ti Voisinage.

Page 15: API SHARING CITY -   · PDF fileSOMMAIRE API Sharing City Bienvenue dans la ville numérique ! 4 Qu’est-ce que Sharing City

CAS PRATIQUES

Visibilité : partager un contenu ou un service Prenons l’exemple d’un utilisateur qui souhaite proposer sa cave en location depuis le site « ouistock.com ».

Lors de la création d’un contenu, l’utilisateur pourra choisir de publier simultanément son annonce sur le site partenaire et sur Mon P’ti Voisinage.

!

!

!

!

API Sharing City - 15

Je publie mon annonce sur mon profil

Publier mon annonce sur Mon Pí ti Voisinage

Multiplier votre visibilitÈ en publiant È galement votre annonce sur votre profil Mon Pí ti Voisinage. Vos voisinsseront notifiÈ s de votre offre.

Capture d’écran du service © Ouistock 2014 - Tous droits réservés

Page 16: API SHARING CITY -   · PDF fileSOMMAIRE API Sharing City Bienvenue dans la ville numérique ! 4 Qu’est-ce que Sharing City

CAS PRATIQUES

Visibilité : partager un contenu ou un service

Après validation, l'utilisateur retrouve sa cave sur son profil Mon P’ti Voisinage. Cliquer sur le lien décrira l’annonce en détails et permettra de se rendre directement sur le site partenaire.

!

!

!

!

API Sharing City - 16

Je publie mon annonce sur mon profil

Publier mon annonce sur Mon Pí ti Voisinage

Multiplier votre visibilitÈ en publiant È galement votre annonce sur votre profil Mon Pí ti Voisinage. Vos voisinsseront notifiÈ s de votre offre.

Je publie mon annonce sur mon pro

!"#$%&'()*'+),+"&"-%+',(

!"#$%&'()"(*&++,-&

.$)/+&(01!

.$-*("+)/'0,"-)&')1234535412

2,/"345/&''&6(6'$$'-))

17)(,')!%"$+89':(#'-);<444

“='&&:)&'-)>:"-"$-)?')-,"-)@:,"-')?A%-0"(')B)0&,-)/A'$+(%"/')'+)/')('&%+":$-)/')

0(:C"D"+E)*%()&A"$$:>%+":$)'-+)/%$-)&')*F%$#'D'$+)/')D'$+%&"+E)G

7&+(8,9/3):&+(:&(;,'3,-&

!"#$%&

IMMOBILIERFÊTES

boule à facette cave

'$()*+$&

COURS

guitare

COUP DE POUCE

coup de pouce

GARDE D’ENFANT

garde d’enfant

!"#$%&#'()*+,-&.$/&0#12333!

"#$%&'()*+

4&#5.%&#6(#7(8&#0)+%9&#(%#1:#(8&*%&#;&#<$.795)(*;&=#&55&6&0%$&#!26>#&+#?@&*#;&6(*;&#>3A#B($#6.)0=#6&#7.*+(7+&$B.%$#B5%0#;@)*C.$6(+).*0#DE

!"#$%&'())")*+%,-$%&+%,#.+%/($.+)(#$+

*,-+.(/(012'

)%&3#4%56'(7(3189%8(:$(;<(=18&(<>;?

<>@(A=#%&

!"#$%&'#()*+

IMMOBILIER

cave

Envoie vers le site partenaire.

Page 17: API SHARING CITY -   · PDF fileSOMMAIRE API Sharing City Bienvenue dans la ville numérique ! 4 Qu’est-ce que Sharing City

CAS PRATIQUES

Nouveaux indicateurs : enrichir une annonce immobilière

De nouveaux indicateurs apparaissent : le bien-être social d’un quartier, l’indice de pollution d’une ville et bien d’autres informations encore qui peuvent enrichir des annonces immobilières ou la connaissance d’un site.

Ces indicateurs peuvent être récupérés grâce à l’API et être remontés sur vos pages.

API Sharing City - 17

Indice Sharing City 98%Les habitants collaborent etsont hyper-connectÈ s ! L' indicecollaboratif est au plus haut etle quartier est gÈ nÈ rateurd' È conomies !

!"#$%&'()#*+,$#!

"

Indice Sharing City 98%Les habitants collaborent etsont hyper-connectÈ s ! L' indicecollaboratif est au plus haut etle quartier est gÈ nÈ rateurd' È conomies !

!"#$%&'()#*+,$#!

"

La plateforme monptivoisinage.com est éditée par TLAG, société anonyme simplifiée au capital de 30 000 euros, sous le n° d'identification 800 163 073 R.C.S SAINT MALO. Mon Pti’ Voisinage et Sharing City sont des marques déposées (n°4076899 et n° 4140076, INPI)