visibility
POST /v1/visibility/targets/{targetId}/local/find
Search the map for the business, so the customer can pick theirs.
Аутентификација
Пошаљите API кључ као bearer токен. Ова крајња тачка не наводи конкретну дозволу у спецификацији, па свом кључу доделите најмања неопходна овлашћења и проверите одговор уместо да претпостављате.
Ова крајња тачка не прихвата id организације. Ваш кључ већ идентификује организацију којој припада, а одговор је ограничен на њу.
Испробајте
Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.
curl -X POST https://api.zinndigital.com/v1/visibility/targets/{targetId}/local/find \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "query": <string>, "geo_id": <integer> }'Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом API-ју како бисте могли да видите стварни одговор. Отворите ову крајњу тачку у API конзоли
Детаљи
One live map search from the chosen town. It is metered as ONE check of the month's allowance (as V1 meters it) and refused with 422 when none is left. Pick a result and save it with PUT /v1/visibility/targets/{targetId}/local.
Параметри
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
targetId (path) | Uuid | Да | The watched domain's id. |
Тело захтева
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
query | string | Да | The business's name. |
geo_id | integer | Да | The town to search from. |
language | string | Не | — |
Одговор
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
results | LocalFindResult[] | Да | — |
Грешке које ова крајња тачка може вратити
401 · 403 · 404 · 422 · 503