Répertorier les sites inclus dans le forfait

Réponses

200Array of plan site objects. Country arrays are truncated below for brevity; the live response lists every supported country.

Response

{  "data": {    "planSites": [      {        "hideAddressSupportedCountries": ["US", "CA", "AU", "IN", "GB"],        "id": 1,        "name": "Google Maps",        "supportedCountries": ["US", "CA", "IN", "GB", "DE"],        "url": "maps.google.com"      },      {        "hideAddressSupportedCountries": ["US", "CA", "AU", "IN", "GB"],        "id": 184,        "name": "Facebook",        "supportedCountries": ["US", "CA", "IN", "GB", "DE"],        "url": "facebook.com"      },      {        "hideAddressSupportedCountries": ["US", "CA", "AU", "GB"],        "id": 2,        "name": "Yelp",        "supportedCountries": ["US", "CA", "GB", "DE", "FR"],        "url": "yelp.com"      }    ]  }}

401Unauthenticated, missing or invalid API key.

429Rate limit exceeded. Retry after the `Retry-After` header value.

Renvoie tous les sites d’annuaires des plateformes de publication inclus dans le forfait associé au compte actuel. Chaque entrée contient un id entier, un name d’affichage, le url du site, la liste des codes pays ISO acceptés par le site (supportedCountries) et les pays dans lesquels l’indicateur de masquage de l’adresse / de zone desservie est pris en compte (hideAddressSupportedCountries).

Cas d’utilisation : créer un sélecteur d’ID de site valides. Avant d’activer ou de désactiver des plateformes de publication pour un établissement, appelez cet endpoint pour connaître les ID de site numériques disponibles dans le forfait. Seuls les ID renvoyés ici peuvent être utilisés ailleurs dans l’API. Associez id à name/url pour afficher un écran de paramètres de soumission lisible par les utilisateurs.

Cas d’utilisation : vérifier au préalable le pays d’un établissement. Filtrez la réponse pour ne conserver que les sites dont supportedCountries inclut le countryIso de l’établissement, afin de ne proposer que les plateformes de publication qui accepteront effectivement la fiche. Pour les entreprises desservant une zone géographique, vérifiez également hideAddressSupportedCountries pour déterminer où l’adresse peut être masquée.

Points d’attention.

Cette liste est limitée au périmètre du forfait et n’est pas paginée : elle renvoie le catalogue complet des sites du forfait dans une seule réponse, sans curseur. Attendez-vous à plusieurs dizaines d’entrées et mettez le résultat en cache plutôt que d’appeler cet endpoint à chaque requête.
supportedCountries et hideAddressSupportedCountries peuvent chacun contenir plus de 50 codes ISO ; l’exemple ci-dessus est tronqué.
Cet endpoint partage la limite de débit du compte ; en cas de 429, respectez l’en-tête Retry-After.

Paramètres

Réponses