Localisateur de succursale
- Melissa Cote (Unlicensed)
VERSION BETA
Avertissement! Certaines des routes nécessiteront des autorisations supplémentaires. Si vous obtenez une réponse «Accès refusé» ou des réponses vides, contactez votre représentant!
- 1 POST {url}/localtrac/store-locator/registerWebhook
- 2 GET {url}/localtrac/store-locator/locations/{businessUuid}
- 3 GET {url}/localtrac/store-locator/businessTags/{businessUuid}
- 4 POST {url}/localtrac/store-locator/businessTags/{businessUuid}
- 5 POST {url}/localtrac/store-locator/businessTags/{businessUuid}/add
- 6 GET {url}/localtrac/store-locator/locationTags/{locationUuid}
- 7 POST {url}/localtrac/store-locator/locationTags/{locationUuid}
- 8 GET {url}/localtrac/store-locator/businessCategories/{businessUuid}
- 9 POST {url}/localtrac/store-locator/businessCategories/{businessUuid}
- 10 POST {url}/localtrac/store-locator/businessCategories/{businessUuid}/add
- 11 GET {url}/localtrac/store-locator/locationCategories/{locationUuid}
- 11.1 Requête
- 11.2 Réponse (200) - Succès
- 11.3 Réponse (403) - Accès interdit
- 12 POST {url}/localtrac/store-locator/locationCategories/{locationUuid}
- 13 GET {url}/localtrac/store-locator/image/{locationUuid}
- 13.1 Requête
- 13.2 Réponse (200) - Succès
- 13.3 Réponse (403) - Accès interdit
- 14 PUT {url}/localtrac/store-locator/image
- 15 DELETE {url}/localtrac/store-locator/image/{imageUuid}
- 15.1 Requête
- 15.2 Réponse (200) - Succès
- 15.3 Réponse (403) - Accès interdit
- 16 GET {url}/localtrac/store-locator/{locationUuid}/fields
- 16.1 Requête
- 16.2 Réponse (200) - Succès
- 16.3 Réponse (403) - Accès interdit
POST {url}/localtrac/store-locator/registerWebhook | |
|---|---|
Cet route enregistre l'URL du webhook du site du client. Chaque fois, l'emplacement est une mise à jour, LOCALTRAC enverra une requête POST à l'URL fournie, en envoyant le paramètre «secret» égal à md5 («webhookSalt»). LOCALTRAC n'envoie pas les champs modifiés ni la liste des emplacements modifiés. Il s'agit simplement d'un signal indiquant que certains emplacements ont été mis à jour. Vous pouvez utiliser la route GET «store-locator / locations» et comparer «lastUpdated» pour savoir quel emplacement a été mis à jour. | |
Requête | |
En-têtes | |
Authorization | <token> jeton obtenu lors de l'authentification |
Accept | application/json |
Body (Exemple) | |
{
"businessUuid":"{businessUuid}",
"webhookUrl":"https://google.com.ua",
"webhookSalt": "very_secure_string_to_be_md5_encoded"
} | |
businessUuid | Uuid de l’entreprise pour enregistrer le webhook. L’option localisateur de succursale doit etre activer pour l’entreprise. |
webhookUrl | URL sur le serveur / site web client à appeler lorsqun emplacement est mis à jour. |
webhookSalt | Chaîne aléatoire qui serait encodée en md5 et transmise avec POST comme paramètre «secret». |
| |
Réponse (200) - Succès | |
En-têtes | |
Content-Type | application/json |
Body | |
{
"success": true
} | |
Réponse (400) - Erreur de validation | |
En-têtes | |
Content-Type | application/json |
Body | |
{
"message": "Provided data contains error(s). See each entry in [errors]",
"errors": {
"businessUuid": "This field is missing."
}
} | |
| |
Réponse (403) - Accès interditCe scénario se produit si vous avez envoyé un businessUuid non existant (ou si Store Localtor n'est pas activé pour cette entreprise). | |
Content-Type | application/json |
Body | |
| |
GET {url}/localtrac/store-locator/locations/{businessUuid} | |
|---|---|
Cette route retournera la liste des succursales del'entreprise fournie, y compris toutes les informations sur la succursale. | |
Requête | |
En-têtes | |
Authorization | <token> jeton obtenu lors de l'authentification |
Accept | application/json |
Réponse (200) - Succès | |
En-têtes | |
Content-Type | application/json |
Body | |
| |
data | Array liste des susccursales |
data[0].uuid | Identifiant unique (uuid) de la succursale dans LOCALTRAC. Il s'agit de l'uuid que vous devez utiliser pour toute autre demande nécessitant un <location_uuid> dans l'url. |
data[0].active | Valeur booléenne représentant l'état de l'emplacement, true pour active et false pour inactive. Lorsqu'un emplacement est défini comme inactif, il n'est surveillé dans aucun répertoire. |
data[0].lastUpdated | Timestamp de la dernière mise à jour sur le champ de n'importe quel emplacement |
data[0].urls | Un tableau contenant les sites Web et les URL de médias sociaux. Clés prises en charge:
|
data[0].payments | Un tableau contenant la liste des modes de paiement. La valeur est une valeur booléenne, true lorsque le mode de paiement est accepté ou false dans le cas contraire. Clés prises en charge:
|
data[0].name | Un tableau des traductions de noms de lieux. Chaque ligne du sous-tableau est une valeur associative de <language>: <name>. A Ce route renvoie par default le nom de la succursale inscrit dans la section store locator de la fiche de la succursale, si la valeur est vide «nom» général de l'emplacement sera retournée. |
data[0].description | Un tableau de toutes les descriptions d'emplacement. Chaque ligne du sous-tableau est une valeur associative de <language>: <description>. |
data[0].communication | Un tableau de toutes les informations de comtact. Clés prises en charge:
|
data[0].storeCode | Identifiant externe donné par le client lors de la création de l'emplacement ou lors de l'importation dans LOCALTRAC à partir d'un répertoire. |
data[0].locale | Langue de la succursale <locale>: description <description>. Nous prenons actuellement en charge que <locale> fr_CA et en_CA. |
data[0].address | Un tableau contenant l'adresse complète. Cette route renvoie "Adresse ligne 1 et 2" de la succursale provenant du store locator. S'il est vide, "adresse line 1 et 2" générale de l'emplacement. |
data[0].storeLocator | Un tableau des informations completentaire au localisateur de magasin d'emplacement. Clés prises en charge:
|
data[0].schedules | Un tableau des heures d'ouverture régulières de la succursale. |
data[0].scheduleExceptions | Un tableau des heures d’ouverture d'exceptions de la succursale. |
data[0].averageRating | Note moyenne Google pour l'année en cours pour cet emplacement. |
|
|
Réponse (403) - Accès interdit | |
En-têtes | |
Content-Type | application/json |
Body | |
| |
GET {url}/localtrac/store-locator/businessTags/{businessUuid} | |
|---|---|
Cet route renvoit la liste des étiquettes/tags associées à l'entreprise. | |
Requête | |
En-têtes | |
Authorization | <token> jeton obtenu lors de l'authentification |
Accept | application/json |
Réponse (200) - Succès | |
En-têtes | |
Content-Type | application/json |
Body | |
| |
uuid | Identifiant unique (uuid) de l’etiquette. Il s'agit de l'uuid que vous devez utiliser pour toute autre demande nécessitant la mise a jour d’un tag. |
translations | Un tableau de traductions du nom de la étiquette/tag. Pour le moment, seules les langues «en» et «fr» sont prises en charge. Les langues sont facultatives (la balise ne peut avoir qu'une seule langue). |
translations.en | Traduction anglaise de l’étiquette/tag. |
translations.fr | Traduction francaise de l'étiquette/tag. |
slug | Un tableau de slug pour les étiquettes/tags.. (généré automatiquement lors de l'insertion / mise à jour du tag). |
slug.en | Slug pour traduction anglaise de l’étiquette/tag. |
slug.fr | Slug pour la traduction francaise de l’étiquette/tag. |
Réponse (403) - Accès interdit | |
En-têtes | |
Content-Type | application/json |
Body | |
| |
POST {url}/localtrac/store-locator/businessTags/{businessUuid} | |
|---|---|
Cet route définit la liste des balises Store Locator, associées à l'entreprise. (Cela effacera toutes les données précédentes et enregistrera la liste fournie) | |
Requête | |
En-têtes | |
Authorization | <token> jeton obtenu lors de l'authentification |
Accept | application/json |
Body (Exemple) | |
| |
tags | Un tableau de étiquettes/tags a sauvegarder. |
tags[0].uuid (optional) | Uuid de l'étiquette/tag, reçu de la route GET. Si elle est fournie, la balise sera mise à jour (les traductions changeront, uuid restera le même). |
tags[0].translations | Un tableau de traductions de la l'étiquette/tag. Seuls «en» et «fr» sont désormais pris en charge. |
tags[0].translations.en (optional) | Slug pour traduction anglaise de l’étiquette/tag. |
tags[0].translations.fr (optional) | Slug pour traduction francaise de l’étiquette/tag. |
Réponse (200) - Succès | |
En-têtes | |
Content-Type | application/json |
Body | |
| |
Réponse (400) - Erreur de validationCe scénario se produit si vous avez envoyé un contenu qui échoue au processus de validation minimum. Par exemple, ne pas fournir de traductions conduira au résultat suivant. | |
En-têtes | |
Content-Type | application/json |
Body | |
| |
| |
Réponse (403) - Accès interditCe scénario se produit si vous avez envoyé un uuid non existant de la balise. | |
En-têtes | |
Content-Type | application/json |
Body | |
| |
| |
Réponse (403) - Accès interditCe scénario se produit si vous avez envoyé businessUuid inexistant. | |
Content-Type | application/json |
Body | |
| |
POST {url}/localtrac/store-locator/businessTags/{businessUuid}/add | |
|---|---|
Cet itinéraire ajoutera une étiquette/tag à l'entreprise et l'associera à l'emplacement (si fourni). | |
Requête | |
En-têtes | |
Authorization | <token> jeton obtenu lors de l'authentification |
Accept | application/json |
Body (Exemple) | |
| |
locationUuid (optional) | Uuid de la succursale. L'étiquette/tag nouvellement créée sera associée à l'emplacement fourni. |
translations | Tableau de traductions de la balise. Seuls «en» et «fr» sont pris en charge. |
translations.en (optional) | Traduction anglaise du nom. |
translations.fr (optional) | Traduction francaise du nom. |
Réponse (200) - Succès | |
En-têtes | |
Content-Type | application/json |
Body | |
| |
uuid | Identifiant unique (uuid) de l’étiquette/tag dans LOCALTRAC. Il s'agit de l'uuid que vous devez utiliser pour toute autre demande de mise a jours des étiquettes/tags d’une succursale. |
Réponse (400) - Erreur de validationCe scénario se produit si vous avez envoyé un contenu qui échoue au processus de validation minimum. Par exemple, ne pas fournir de traductions conduira au résultat suivant. | |
En-têtes | |
Content-Type | application/json |
Body | |
| |
Réponse (403) - Accès interditCe scénario se produit si vous avez envoyé businessUuid ou locationUuid non existant | |
Content-Type | application/json |
Body | |
| |
GET {url}/localtrac/store-locator/locationTags/{locationUuid} | |
|---|---|
Cet itinéraire renverra la liste des étiquettes/tagsStore Locator, associées à l'emplacement. | |
Requête | |
En-têtes | |
Authorization | <token> jeton obtenu lors de l'authentification |
Accept | application/json |
Réponse (200) - Succès | |
En-têtes | |
Content-Type | application/json |
Body | |
| |
uuid | Uuid de la succursale. L'étiquette/tag nouvellement créée sera associée à l'emplacement fourni. |
translations | Un tableau de traductions des étiquettes/tags. Pour le moment, seules les langues «en» et «fr» sont prises en charge. Les langues sont facultatives (la balise ne peut avoir qu'une seule langue). |
translations.en | Traduction anglaise du nom. |
translations.fr | Traduction francaise du nom. |
slug | Un tableau de slug pour les traductions du nom des étiquettes/tags (généré automatiquement lors de l'insertion / mise à jour). |
slug.en | Slug pour traduction anglaise de l’étiquette/tag. |
slug.fr | Slug pour traduction francaise de l’étiquette/tag. |
Réponse (403) - Accès interdit | |
En-têtes | |
Content-Type | application/json |
Body | |
| |
POST {url}/localtrac/store-locator/locationTags/{locationUuid} | |
|---|---|
Cet route définira la liste des balises Store Locator, associées à la succursale. (Cela effacera toutes les données précédentes et enregistrera la liste fournie) | |
Requête | |
En-têtes | |
Authorization | <token> jeton obtenu lors de l'authentification |
Accept | application/json |
Body (Exemple) | |
| |
tags | Un tableau d’étiquette/tag à associer à la succursale. |
tags[0].uuid | Identifiant unique de l'étiquette/tag à associer. |
Réponse (200) - Succès | |
En-têtes | |
Content-Type | application/json |
Body | |
| |
Réponse (400) - Erreur de validationCe scénario se produit si vous avez envoyé un contenu qui échoue au processus de validation minimum. Par exemple, une faute de frappe dans le nom du paramètre conduira au résultat suivant | |
En-têtes | |
Content-Type | application/json |
Body | |
| |
| |
Réponse (403) - Accès interditCe scénario se produit si vous avez envoyé un uuid d'étiquette/tag non existant | |
En-têtes | |
Content-Type | application/json |
Body | |
| |
| |
Réponse (403) - Accès interditCe scénario se produit si vous avez envoyé un identifiant unique de succursale non existant (locationUuid). | |
Content-Type | application/json |
Body | |
| |
GET {url}/localtrac/store-locator/businessCategories/{businessUuid} | |
|---|---|
Cette route renverra la liste des catégories de Store Locator, associées à l'entreprise. | |
Requête | |
En-têtes | |
Authorization | <token> jeton obtenu lors de l'authentification |
Accept | application/json |
Réponse (200) - Succès | |
En-têtes | |
Content-Type | application/json |
Body | |
| |
uuid | Identifiant unique de la catégorie (uuid) dans LOCALTRAC . C'est l'uuid que vous devez utiliser pour toute autre demande de mise à jour de la catégorie. |
translations | Un tableau de traductions du nom de la catégorie. Pour le moment, seules les langues «en» et «fr» sont prises en charge. Les langues sont facultatives (la catégorie ne peut avoir qu'une seule langue). |
translations.en | Traduction anglaise du nom de la catégorie. |
translations.fr | Traduction francaise du nom de la catégorie. |
slug | Un tableau de slug pour les traductions du nom de la catégorie. (généré automatiquement lors de l'insertion / mise à jour de la catégorie). |
slug.en | Slug pour la traduction anlaise de la catégorie. |
Slug pour la traduction francaise de la catégorie. | |
Réponse (403) - Accès interdit | |
En-têtes | |
Content-Type | application/json |
Body | |
| |
POST {url}/localtrac/store-locator/businessCategories/{businessUuid} | |
|---|---|
Cette route définira la liste des catégories de Store Locator, associées à l'entreprise. (Cela effacera toutes les données précédentes et enregistrera la liste fournie). | |
Requête | |
En-têtes | |
Authorization | <token> jeton obtenu lors de l'authentification |
Accept | application/json |
Body (Exemple) | |
| |
categories | Un tableau de catégories à enregistrer |
categories[0].uuid (optional) | Uuid de la catégorie, reçu de la route GET. Si elle est fournie, la catégorie sera mise à jour (les traductions changeront, uuid reste le même). |
categories[0].translations | Liste (array) des traductions des categories. Seules les langues «en» et «fr» sont prises en charge. |
categories[0].translations.en (optional) | Traduction anglaise du nom. |
categories[0].translations.fr (optional) | Traduction francaise du nom. |
Réponse (200) - Succès | |
En-têtes | |
Content-Type | application/json |
Body | |
| |
Réponse (400) - Erreur de validationCe scénario se produit si vous avez envoyé un contenu qui échoue au processus de validation minimum. Par exemple, ne pas fournir de traductions conduira au résultat suivant | |
En-têtes | |
Content-Type | application/json |
Body | |
| |
| |
Réponse (403) - Accès interditCe scénario se produit si vous avez envoyé un uuid non existant de la catégorie | |
En-têtes | |
Content-Type | application/json |
Body | |
| |
| |
Réponse (403) - Accès interditCe scénario se produit si vous avez envoyé businessUuid inexistant | |
Content-Type | application/json |
Body | |
| |
POST {url}/localtrac/store-locator/businessCategories/{businessUuid}/add | |
|---|---|
Cette route ajoute une catégorie à l'entreprise et l'associera à l'emplacement (si fourni). | |
Requête | |
En-têtes | |
Authorization | <token> jeton obtenu lors de l'authentification |
Accept | application/json |
Body (Exemple) | |
| |
locationUuid (optional) | Identifiant unique (Uuid) de la succursale. La catégorie nouvellement créée sera associée à la succursale indiqué. |
translations | Tableau de traductions des catégories. Seuls «en» et «fr» sont pris en charge. |
translations.en (optional) | Traduction anglaise du nom. |
translations.fr (optional) | Traduction francaise du nom. |
Réponse (200) - Succès | |
En-têtes | |
Content-Type | application/json |
Body | |
| |
uuid | Identifiant unique (uuid) de la catégorie. C'est l'uuid que vous devez utiliser pour toute autre demande de mise à jour de la catégorie ou de l'associer à des emplacements. |
Réponse (400) - Erreur de validationCe scénario se produit si vous avez envoyé un contenu qui échoue au processus de validation minimum. Par exemple, ne pas fournir de traductions conduira au résultat suivant | |
En-têtes | |
Content-Type | application/json |
Body | |
| |
| |
Réponse (403) - Accès interditCe scénario se produit si vous avez envoyé businessUuid ou locationUuid non existant | |
Content-Type | application/json |
Body | |
| |
GET {url}/localtrac/store-locator/locationCategories/{locationUuid} | |
|---|---|
Cette route renverra la liste des catégories de Store Locator, associées à l'emplacement | |
Requête | |
En-têtes | |
Authorization | <token> jeton obtenu lors de l'authentification |
Accept | application/json |
Réponse (200) - Succès | |
En-têtes | |
Content-Type | application/json |
Body | |
| |
uuid | Identifiant unique (uuid) de la catégorie. C'est l'uuid que vous devez utiliser pour toute autre demande de mise à jour de la catégorie ou de l'associer à des succursales. |
translations | Un tableau (array) de traductions du nom de la catégorie. Pour le moment, seules les langues «en» et «fr» sont prises en charge. Les langues sont facultatives (la catégorie ne peut avoir qu'une seule langue). |
translations.en | Traduction anglaise de la catéorie. |
translations.fr | Traduction francaise de la catégorie. |
slug | Un tableau(array) de slug pour les traductions du nom de la catégorie. (généré automatiquement lors de l'insertion / mise à jour de la catégorie). |
slug.en | Slug de la traduction anglaise de la catégorie. |
slug.fr | Slug de la traduction anglais de la catégorie. |
Réponse (403) - Accès interdit | |
En-têtes | |
Content-Type | application/json |
Body | |
| |
POST {url}/localtrac/store-locator/locationCategories/{locationUuid} | |
|---|---|
Cette route définit la liste des catégories de Store Locator, associées à la succursale. (Cela effacera toutes les données précédentes et enregistrera la liste fournie) | |
Requête | |
En-têtes | |
Authorization | <token> jeton obtenu lors de l'authentification |
Accept | application/json |
Body (Exemple) | |
| |
categories | Un tableau (array) de catégories associé à la succursale. |
categories[0].uuid | Identifiant unique(Uuid) de la catégorie, à associer. |
Réponse (200) - Succès | |
En-têtes | |
Content-Type | application/json |
Body | |
| |
Réponse (400) - Erreur de validationCe scénario se produit si vous avez envoyé un contenu qui échoue au processus de validation minimum. Par exemple, une faute de frappe dans le nom du paramètre conduira au résultat suivant | |
En-têtes | |
Content-Type | application/json |
Body | |
| |
| |
Réponse (403) - Accès interditCe scénario se produit si vous avez envoyé un uuid non existant de la catégorie | |
En-têtes | |
Content-Type | application/json |
Body | |
| |
| |
Réponse (403) - Accès interditCe scénario se produit si vous avez envoyé un emplacement non existant | |
Content-Type | application/json |
Body | |
| |
GET {url}/localtrac/store-locator/image/{locationUuid} | |
|---|---|
Cette route renvoit la liste des images de Store Locator, associées à l'emplacement | |
Requête | |
En-têtes | |
Authorization | <token> jeton obtenu lors de l'authentification |
Accept | application/json |
Réponse (200) - Succès | |
En-têtes | |
Content-Type | application/json |
Body | |
| |
uuid | Identifiant unique (uuid) de l'image de localisation de magasin pour cet emplacement. |
url | URL de l'image originale |
thumbnail | URL de l'image redimensionnée (vignette 95x95). |
mime | Type d’image (mime) |
description | Description de l’image |
createdAt | Timestamp |
Réponse (403) - Accès interdit | |
En-têtes | |
Content-Type | application/json |
Body | |
| |
PUT {url}/localtrac/store-locator/image | |
|---|---|
Cette route attribut une image à la succursale. | |
Requête | |
En-têtes | |
Authorization | <token> jeton obtenu lors de l'authentification |
Accept | application/json |
Body (Exemple) | |
| |
image_uuid | Identifiant unique (Uuid) de l'image |
location_uuid | Identifiant unique (Uuid) de la succursale |
description | Description de l’image |
Réponse (200) - Succès | |
En-têtes | |
Content-Type | application/json |
Body | |
| |
uuid | Identifiant unique (uuid) de l'image de la succursale |
url | URL de l'image d'origine |
thumbnail | URL de l'image redimensionnée (vignette 95x95). |
| |
Réponse (400) - Erreur de validationCe scénario se produit si vous avez envoyé un contenu qui échoue au processus de validation minimum. Par exemple, une faute de frappe dans le nom du paramètre conduira au résultat suivant | |
En-têtes | |
Content-Type | application/json |
Body | |
| |
| |
Réponse (403) - Accès interditCe scénario se produit si vous avez envoyé un image_uuid non existant | |
Content-Type | application/json |
Body | |
| |
DELETE {url}/localtrac/store-locator/image/{imageUuid} | |
|---|---|
Cette route supprimera l'image de localisation de magasin. | |
Requête | |
En-têtes | |
Authorization | <token> jeton obtenu lors de l'authentification |
Accept | application/json |
Réponse (200) - Succès | |
En-têtes | |
Content-Type | application/json |
Body | |
| |
| |
Réponse (403) - Accès interditCe scénario se produit si vous avez envoyé une imageUuid non existante | |
Content-Type | application/json |
Body | |
| |
GET {url}/localtrac/store-locator/{locationUuid}/fields | |
|---|---|
Cette route renvoit la liste des champs Store Locator, associés à la succursale. Pour le moment, seul «externalId» est pris en charge en tant que champ personnalisé. | |
Requête | |
En-têtes | |
Authorization | <token> jeton obtenu lors de l'authentification |
Accept | application/json |
Réponse (200) - Succès | |
En-têtes | |
Content-Type | application/json |
Body | |
| |
Réponse (403) - Accès interdit | |
En-têtes | |
Content-Type | application/json |
Body | |
| |