Introduction

L’API de Local Diffusion a pour objet de mettre à disposition notre base de données, constituée de commerçants locaux, qui ne cesse de croître. Vous pourrez ainsi afficher des informations actualisées et des contenus enrichis comme des menus, des offres spéciales, des photographies, des horaires d’ouverture… Notre objectif est donc de partager toutes ces informations avec vous afin d’aider toujours davantage les commerçants à gérer leur présence sur le web et afin de vous aider à avoir des contenus toujours plus riches et actualisés.

API Key

Pour accéder aux données de l'API, vous aurez besoin d'une API Key. Celle-ci peut être générée dans la page de génération de la API KEY de ce site.
C'est une chaîne de 26 caractères composée de chiffres et de lettres

Dans les exemples de cette page, l'API Key est égale à 1a2b3c4d5e et n'est là qu'à titre d'exemple.

Le paramètre pour spécifier son API Key est apiKey :

?apiKey=1a2b3c4d5e

Format de retour

Par défaut, la réponse est envoyée en JSON. Il est possible de récupérer la réponse au format XML en spécifiant le paramètre format dans l'URL :

?format=xml

Le format de retour est spécifié dans la partie info de la réponse :

JSON

{
    info: {
        code: 204,
        contentType: "application/json"
    },
    data: []
}

XML

<localDiffusion>
    <info>
        <code>204</code>
        <contentType>application/xml</contentType>
    </info>
    <data/>
</localDiffusion>

Codes de retour

L'API retourne un code de retour différent dans les cas suivant :

  • Code 200 : Aucune erreur ne s'est produite ;
  • Code 204 : Les données demandées n'existent pas ;
  • Code 206 : Un attribut est mal spécifié dans l'URL ;
  • Code 401 : L'API Key n'est pas valide ou pas spécifiée ;
  • Code 405 : La méthode demandée n'existe pas ;
  • Code 500 : Une erreur interne du serveur s'est produite.

Ce code est retourné dans la partie info de la réponse :

{
    info: {
        code: 401,
        contentType: "application/json"
    }
}

Recherche d'un commerce

Nous allons détailler ici les différentes méthodes de recherche d'un commerce.

Rechercher un commerce par son identifiant

Pour rechercher un commerce par son identifiant, il faut spécifier le paramètre idBusiness :

http://www.localdiffusion.fr/demo/dev/business/getById/?apiKey=1a2b3c4d5e&idBusiness=1

Testez ici : Test (nouvelle fenêtre)

Réponse :

{
    info: {
        code: 200,
        contentType: "application/json"
    },
    data: {
        idBusiness: "1",
        name: "Firenze"
    }
}

Recherche d'un commerce par son adresse

Pour rechercher un commerce par son adresse, il faut accéder à l'URL getByAddress spécifier les paramètres businessAddress et businessZipCode :

http://www.localdiffusion.fr/demo/dev/business/getByAddress/?apiKey=1a2b3c4d5e&businessAddress=30 av de versailles&businessZipCode=75000

Testez ici : Test (nouvelle fenêtre)

Réponse :

{
    info: {
        code: 200,
        contentType: "application/json"
    },
    data: {
        idBusiness: "1",
        name: "Firenze",
        address: "30 Avenue de Versailles",
        zipCode: "75016"
    }
}

Récupérer les 20 prochains ID à partir d'un identifiant de point de vente

Pour afficher le point de vente suivant, il faut accéder à l'URL business/getNextBusinessIds et spécifier le paramètre idBusiness :

http://www.localdiffusion.fr/demo/dev/business/getNextBusinessIds/?apiKey=1a2b3c4d5e&idBusiness=1

Testez ici : Test (nouvelle fenêtre)

Réponse :

{
    info: {
        code: 200,
        contentType: "application/json"
    },
    "NexttwentybusinessId": [
        {
            "idBusiness":"4",
            "name":"Le Grand M\u00e9ricourt"
            },
        {"idBusiness":"5","name":"Chez Trassoudaine"},
        {"idBusiness":"7","name":"L'oriental"},
        {"idBusiness":"8","name":"Le Zyriab"},
        {"idBusiness":"9","name":"Sous le c\u00e8dre"},
        {"idBusiness":"11","name":"Chez Lisa"},
        {"idBusiness":"14","name":"Cedrus"}
        ]
}

Affichage des dernières modifications opérées sur la base de données

La base de donnée est mise à jour régulièrement et en continu. L'identifiant de modification est l'APIEventId. Chaque modification à un APIEventId unique. Vous pouvez recupérer le numéro de point de vente mis à jour ainsi que le type de mise à jour.

Récupérer le dernier identifiant d'évenement disponible

Pour afficher le dernier identifiant d'événement disponible, il faut accéder à l'URL business/getLastEventId et spécifier le paramètre idBusiness :

http://www.localdiffusion.fr/demo/dev/business/getLastEventId/?apiKey=1a2b3c4d5e&idBusiness=1

Testez ici : Test (nouvelle fenêtre)

Réponse :

{
info: {
        code: 200,
        contentType: "application/json"
    },
        "lastEventId":
            {
                "idBusiness":"3149",
                "APIEventId":"401",
                "timeofevent":"2014-03-07 13:38:00",
                "evntDescription":"Opening Hour of Wednesday changed"
            }
}   

Récupérer le prochain identifiant d'événement disponible à partir d'un événement donné

Pour afficher le point de vente suivant, il faut accéder à l'URL business/getNextEventId et spécifier le paramètre idBusiness :

http://www.localdiffusion.fr/demo/dev/business/getNextEventId/?apiKey=1a2b3c4d5e&APIEventId=1

Testez ici : Test (nouvelle fenêtre)

Réponse :

{
info: {
        code: 200,
        contentType: "application/json"
    },

    "NextEventId":
    {
        "idBusiness":"3136",
        "APIEventId":"388",
        "timeofevent":"2014-03-07 13:38:00",
        "evntDescription":Opening Hour of Monday changed"
    }
}

Affichages des différentes informations sur un commerce

Adresse d'un commerçant

Pour afficher l'adresse d'un commerce, il faut accéder à l'URL business/getAddress et spécifier le paramètre idBusiness :

http://www.localdiffusion.fr/demo/dev/business/getAddress/?apiKey=1a2b3c4d5e&idBusiness=1

Testez ici : Test (nouvelle fenêtre)

Réponse :

{
    info: {
        code: 200,
        contentType: "application/json"
    },
    address: {
        idBusiness: "1",
        name: "Firenze",
        address1: "30 Avenue de Versailles",
        address2: "",
        address3: "",
        zipCode: "75016",
        city: "Paris"
    }
}

Coordonnées du commerce

Pour afficher les coordonnées d'un commerce, il faut accéder à l'URL business/getContactInformations et spécifier le paramètre idBusiness :

http://www.localdiffusion.fr/demo/dev/business/getContactInformations/?apiKey=1a2b3c4d5e&idBusiness=1

Testez ici : Test (nouvelle fenêtre)

Réponse :

{
    info: {
        code: 200,
        contentType: "application/json"
    },
    contact: {
        idBusiness: "1",
        name: "Firenze",
        phoneNumber: "0145243498",
        faxNumber: "",
        email: "",
        website: "http://www.restaurant-firenze.fr/"
    }
}

Informations sur un commerce

Pour afficher des informations relatives à un commerce, il faut accéder à l'URL business/getInformations et spécifier le paramètre idBusiness :

http://www.localdiffusion.fr/demo/dev/business/getInformations/?apiKey=1a2b3c4d5e&idBusiness=1

Testez ici : Test (nouvelle fenêtre)

Réponse :

{
    info: {
        code: 200,
        contentType: "application/json"
    },
    informations: {
        name: "Firenze",
        SIRET: "",
        phoneNumber: "0102030405",
        faxNumber: "",
        category: "restaurant italien",
        isOpen: "1",
        description: "Courte description.",
        seatsNumber: "20",
        religiousRestrictions: ""
    }
}

Horaires d'un commerce

Pour afficher les horaires associés à un commerce, il faut accéder à l'URL business/getOpeningHours et spécifier le paramètre idBusiness :

http://www.localdiffusion.fr/demo/dev/business/getOpeningHours/?apiKey=1a2b3c4d5e&idBusiness=1

Testez ici : Test (nouvelle fenêtre)

Réponse :

{
    info: {
        code: 200,
        contentType: "application/json"
    },
    openingHours: {
        mardi: [
            {
                startTime: "11h45",
                endTime: "14h00"
            },
            {
                startTime: "19h00",
                endTime: "22h00"
            }
        ],
        mercredi: [
            {
                startTime: "11h45",
                endTime: "14h00"
            }
        ],
        jeudi: [
            {
                startTime: "11h45",
                endTime: "14h00"
            },
            {
                startTime: "19h00",
                endTime: "22h00"
            }
        ],
        vendredi: [
            {
                startTime: "11h45",
                endTime: "14h00"
            },
            {
                startTime: "19h00",
                endTime: "22h00"
            }
        ]
    }
}

Liste des services associés

Pour afficher les services associés à un commerce, il faut accéder à l'URL business/getServices et spécifier le paramètre idBusiness :

http://www.localdiffusion.fr/demo/dev/business/getServices/?apiKey=1a2b3c4d5e&idBusiness=1

Testez ici : Test (nouvelle fenêtre)

Réponse :

{
    info: {
        code: 200,
        contentType: "application/json"
    },
    services: {
        service_1: "a emporter",
        service_2: "wifi"
    }
}

Grille tarifaire d'un commerce

Pour afficher la grille tarifaire d'un commerce, il faut accéder à l'URL business/getMenus et spécifier le paramètre idBusiness :

http://www.localdiffusion.fr/demo/dev/business/getMenus/?apiKey=1a2b3c4d5e&idBusiness=1

Testez ici : Test (nouvelle fenêtre)

Réponse :

{
info: {
    code :200,
    contentType : "application\/json"
    },"
menus :[
    {
    category    :   "entrée",
    plate       :   "Carpaccio de magret de canard aux 5 épices",
    price       :   "12",
    description :   "salade, haricots verts à l'huile de noix et parmesan"
    },
    {
    category    :   "plat",
    plate       :   "Méli-mélo de légumes grillés marinés au citron et aux herbes",
    price       :   "21",
    description :   "sauce basilic au miel d'acacia et gingembre"}
    ]
}

Liste des coordonnées associés

Pour afficher les coordonnes des systèmes généraux de positionnement (GPS) associés à un commerce, il faut accéder à l'URL business/getBusinessGps et spécifier le paramètre idBusiness :

http://www.localdiffusion.fr/demo/dev/business/getBusinessGps/?apiKey=1a2b3c4d5e&idBusiness=1

Testez ici : Test (nouvelle fenêtre)

Réponse :

{
    info: {
        code: 200,
        contentType: "application/json"
    },

    "Gps":
        [
            {
                "gps_longitude":"3\u00b0 57' 51.1",
                "gps_latitude":"41\u00b0 36' 17.0",
                "googlemap_url":"http:\/\/l1calhost\/localdiffusiong\/ldiffusion\/step_one"
            }
        ]
}

Liste des photos associés

Pour afficher les photographies associés à un commerce, il faut accéder à l'URL business/getPhoto et spécifier le paramètre idBusiness :

http://www.localdiffusion.fr/demo/dev/business/getPhoto/?apiKey=1a2b3c4d5e&idBusiness=1

Testez ici : Test (nouvelle fenêtre)

Réponse :

{
    info: {
        code: 200,
        contentType: "application/json"
    },

    "Photo":
    [
        {
            "pictureName":"1387358621_12_Penguins.jpg",
            "picturePath":"http:\/\/localdiffusion.com\/uploaded\/user_picture\/1387358621_12_pizza_aux_anchoix.jpg"
        }
    ]
}

Liste de les offres spéciales associées à un point de vente

Pour afficher les offres speciales associées à un commerce, il faut accéder à l'URL business/getBusinessSpecialOffer et spécifier le paramètre idBusiness :

http://www.localdiffusion.fr/demo/dev/business/getBusinessSpecialOffer/?apiKey=1a2b3c4d5e&idBusiness=1

Testez ici : Test (nouvelle fenêtre)

Réponse :

{
    info: {
        code: 200,
        contentType: "application/json"
    },
    specialoffer:
        [
            {
                "idBusiness":"3160",
                "special_offer":"Livraison gratuite à 5Km"
            }
        ]
}
Dernières modifications faites le 11/04/2014