Profiles
Description
Utilisez ce point de terminaison pour récupérer les Local Profiles d'un emplacement précis à l'aide d'un identifiant. Les profils sont une représentation d'une géographie précise qui comprend le centroïde, une boîte englobante de la zone, ainsi que quatre paragraphes :
- Résumé, qui résume la zone et permet d'en expliquer rapidement et brièvement les points forts.
- Transport, qui explique l'accessibilité et la praticité des différents modes de transport tels que la marche, la conduite, le vélo ou le transport en commun.
- Services, qui met en évidence l'accessibilité des besoins et services courants tels que les restaurants, les épiceries et les pharmacies dans la zone.
- Caractère, qui décrit le dynamisme, la verdure, l'animation et la vie nocturne de la géographie donnée.
- Logement, qui détaille la composition des habitations par type de logement, nombre de chambres, taux d'occupation par les propriétaires et année de construction.
Les profils peuvent être récupérés en fournissant le geog_id précis (obtenu à l'aide du point de terminaison Geographies) ou en fournissant une paire de coordonnées lat et lng en argument. Voir les exemples ci-dessous.
Les traductions françaises ne sont disponibles que pour les emplacements canadiens.
GET /v3/profiles
GET /v3/profiles
En-tête
Cette API utilise l'authentification par jeton JWT. Ce jeton porteur (Bearer) JWT est ce qui est utilisé pour remplir
l'en-tête Authorization ci-dessous.
Les instructions pour récupérer ce jeton se trouvent dans Premiers pas.
| En-tête | Statut | Description |
|---|---|---|
| Authorization | requis | Votre jeton porteur récupéré depuis notre API d'autorisation, ex. Bearer eyJhbGci... |
| Accept | requis | Le type de données demandé; cette API retournera application/json. |
Chaîne de requête
GET /v3/profiles?lat={lat}&lng={lng}
| Parameter | Status | Description |
|---|---|---|
| lat | requis* | Un nombre décimal entre -90 et 90, représentant la latitude. |
| lng | requis* | Un nombre décimal entre -180 et 180, représentant la longitude. |
| level | optionnel | Le niveau géographique du profil à récupérer. Si la valeur est nulle, le plus petit niveau correspondant est renvoyé. Par défaut : null. |
| locale | optionnel | Valeur de chaîne représentant la langue dans laquelle les profils doivent être renvoyés. Disponible : en (anglais), fr (français) Par défaut : en |
GET /v3/profiles/{geog_id}
Les valeurs acceptées pour geog_id sont de la forme g10_*, g20_*, g30_*, g32_*, g35_*, g37_* et g38_*. Toute autre valeur entraînera un code de statut 404 (introuvable).
GET /v3/profiles/{geog_id}
En-tête
Cette API utilise l'authentification par jeton JWT. Ce jeton porteur (Bearer) JWT est ce qui est utilisé pour remplir
l'en-tête Authorization ci-dessous.
Les instructions pour récupérer ce jeton se trouvent dans Premiers pas.
| En-tête | Statut | Description |
|---|---|---|
| Authorization | requis | Votre jeton porteur récupéré depuis notre API d'autorisation, ex. Bearer eyJhbGci... |
| Accept | requis | Le type de données demandé; cette API retournera application/json. |
Chaîne de requête
| Parameter | Status | Description |
|---|---|---|
| locale | optionnel | Valeur de chaîne représentant la langue dans laquelle les profils doivent être renvoyés. Disponible : en (anglais), fr (français) Par défaut : en |
Exemples d'utilisation
- NodeJS
require('node-fetch')('https://api.locallogic.co/v3/profiles/g20_f25dyhf3?' + new URLSearchParams({
locale: 'en',
}), {
method: 'GET',
headers: {
Accept: 'application/json',
Authorization: 'Bearer eyJhbGciOiJ...'
}
})
.then(response => response.json())
.then(body => {
console.log(body)
})
.catch(error => {
console.log(error)
})
Exemple de réponse
{
"data": {
"bounding_box": {
"east": -73.51738361127795,
"north": 45.53938230417042,
"south": 45.48710983364872,
"west": -73.60695342963047
},
"centroid": {
"lat": 45.5097221239011,
"lng": -73.56099384933795
},
"id": "g20_f25dyhf3",
"intro": "The borough of Ville-Marie can be found in the city of Montréal, Quebec, which is situated in the Greater Montreal metropolitan area.",
"name": "Ville-Marie",
"profiles": {
"character": "Ville-Marie is a great part of Montréal for home buyers who enjoy both indoor and outdoor activities. Finding things to do is very easy in this area. There is a broad selection of entertainment venues, the streets are very often busy with people, and with its over 100 nightlife venues, there are options for nighttime activities. Rue Saint-Paul is among the most lively streets in this area. There is a good amount of greenery in this part of Montréal; it is very easy to get to green spaces in the borough since there are over 50 of them close by for residents to visit. In addition, residents will find that the majority of streets have reasonably good tree coverage.",
"housing": "In Ville-Marie, most dwellings are large apartment buildings, while small apartment buildings are also present in the housing stock. Around 30% of homes in this borough were constructed pre-1960, while many of the remaining buildings were built in the 1960s and the 1980s. This part of Montréal offers mainly two bedroom and one bedroom homes. Renters occupy roughly 70% of the dwellings in Ville-Marie and owners occupy the remainder.",
"services": "Both general and specialty grocery stores are usually accessible within a short walk from anywhere in this part of the city. There are over 100 supermarkets in Ville-Marie, and the best selection can be found on streets such as Avenue du Parc. Moreover, thanks to 1000-odd restaurants and cafes in Ville-Marie, there is typically a place to get a meal or beverage just around the corner. Residents benefit from a very large number of nearby clothing stores. With respect to education, in Ville-Marie, parents and their kids will usually be able to access schools and daycares by walking.",
"summary": "Ville-Marie in Montréal, Quebec is a vibrant neighborhood that offers easy access to public transportation, a plethora of diverse dining options, and convenient grocery and shopping locations. The area is also known for its bike-friendly infrastructure and plenty of green spaces for outdoor activities. With a bustling nightlife and a variety of entertainment venues, residents can easily find things to do. The housing stock primarily consists of large apartment buildings, offering a range of options for renters and owners. Ville-Marie is perfect for those seeking a lively and accessible neighborhood with a rich urban atmosphere.",
"transport": "Regardless of the means of transportation, it is very simple to move around in Ville-Marie. The great public transit access makes transit a viable option for many due to plenty of nearby rapid transit stations with access to the Orange Line, Green Line and Yellow Line, and over 50 nearby bus lines. Physically active home buyers will also be pleased with the very walk-friendly nature of this area; running common errands is very convenient, and various businesses are reasonably nearby. Ville-Marie is bicycling-friendly since the bicycling network is quite extensive, and bike-share stations are hardly ever more than a short walk away."
},
"type": "profiles"
},
"meta": {
"geometry": [],
"sections": {
"character": "Character",
"housing": "Housing",
"services": "Services",
"summary": "Summary",
"transport": "Transportation"
}
}
}
Important : assurez-vous d'afficher les informations sous data.attributes.* en tant que HTML.
Implémentations SDK
Profiles est utilisé par trois SDK de Local Logic :
| SDK | Description |
|---|---|
| NeighborhoodHero SDK | Récupère le nom du quartier et le texte résumé du quartier. |
| NeighborhoodCharacteristics SDK | Récupère les paragraphes de caractéristiques résumant le transport, les services et le caractère de chaque quartier. |
Codes de réponse
Lorsque vous appelez l'API de Local Logic, vous pouvez recevoir un code de réponse HTTP indiquant une erreur ou une absence de données. Ces erreurs sont expliquées ci-dessous.
En général, les codes d'erreur commençant par « 4 » sont dus à un appel d'API invalide et peuvent être corrigés de votre côté, alors que les codes d'erreur commençant par « 5 » sont dus à des erreurs de serveur (c'est-à-dire des problèmes de notre côté). Si vous recevez quelque chose qui n'est pas décrit ici, veuillez communiquer avec nous à support@locallogic.co.
204 - No Content
Ce « code d'erreur » n'en est pas un et se produit lorsque nous n'avons pas les données requises pour un emplacement précis. Par exemple, si vous envoyez une paire lat/lng pour obtenir des scores dans des régions inhabitées du nord du Canada, nous pouvons retourner une réponse 204 vide, car nous reconnaissons l'emplacement, mais nous ne calculons pas de scores dans des endroits aussi éloignés, donc il n'y a rien à retourner.
400 - BadRequest
Ce code d'erreur se produit lorsque les données saisies dans la requête sont incorrectes. Utilisez le champ detail de la réponse pour obtenir des précisions. Exemple :
{
"code": "LocalLogic.API.BadRequest",
"detail": "ValidationErrors: AroundEndpoint is invalid:\n\tinclude is invalid: \"bad_input\" is not an acceptable value: \"groceries\", \"restaurants\", \"nightlife\", \"cafes\", \"shopping\", \"daycares\", \"primary_schools\", \"high_schools\""
}
401 - Unauthorized
Ce code d'erreur se produit lorsque votre clé API ne peut pas accéder à certaines ressources ou à certains emplacements. Par exemple, certaines clés API ne peuvent accéder qu'à certains pays, états ou provinces. N'hésitez pas à communiquer avec nous pour plus d'information.
{
"code": "LocalLogic.API.Unauthorized",
"detail": "Your API KEY doesn't support this region"
}
403 - Forbidden
Ce code d'erreur se produit lorsque vous avez oublié d'inclure les identifiants de sécurité dans votre requête ou lorsque vous demandez un paramètre auquel vous n'avez pas accès.
{
"message": "Forbidden"
}
404 - NotFound
Ce code d'erreur se produit lorsque nous n'avons pas de données pour l'emplacement demandé. Par exemple, si vous envoyez une paire lat/lng pour un emplacement en Antarctique, nous retournerons cette erreur, car nous n'avons pas (encore!) de données pour l'Antarctique.
{
"code": "LocalLogic.API.NotFound",
"detail": "No Location Scores found for this location."
}
422 - Unprocessable Entity
Ce code d'erreur est retourné lorsque les bons paramètres ont été envoyés, mais que les données qu'ils contiennent ne sont pas valides. Par exemple, si vous envoyez une paire lat/lng et que la latitude est invalide (c.-à-d. hors de la plage [-90, 90]) ou que la longitude est invalide (c.-à-d. hors de la plage [-180, 180]). Le message retourné expliquera le problème précis avec vos paramètres qui les rend invalides.
{
"message": "Latitude must be within [-90, 90], Longitude must be within [-180, 180], Requires at least lat/lng pair, or geography_ids. None supplied.",
"code": "LocalLogic.API.BadRequest",
"statusCode": 422
}
429 - Too Many Requests
Ce code d'erreur peut être retourné lorsque vous devez limiter le débit de vos requêtes. À l'interne, nous établissons des limites qui dépassent toutes les limites contractuelles pouvant entraîner le retour de ce code d'erreur. Si vous avez des questions ou si vous voyez cette erreur, veuillez communiquer avec nous à support@locallogic.co.
500 - ServerError
Ce code d'erreur signifie qu'une erreur s'est produite de notre côté. N'hésitez pas à réessayer la même requête pour voir si le problème persiste. Si vous recevez beaucoup de ces erreurs, veuillez communiquer avec nous à support@locallogic.co.
{
"code": "LocalLogic.API.ServerError",
"detail": "No Location Scores found for this location."
}
502 - BadGateway
Ce code d'erreur signifie qu'une erreur provient de notre fournisseur infonuagique. N'hésitez pas à réessayer la même requête pour voir si le problème persiste.
{
"message": "Internal server error"
}