platform-transfers
POST /v1/platform-transfers
Book a platform transfer (nothing is charged yet).
Аутентификация
Отправьте ключ API в качестве токена носителя (bearer token). Ключ должен иметь разрешение billing.view; ключ без него отклоняется с кодом 403, а не 404.
Идентификатор вашей организации
Этот эндпоинт принимает org_id в качестве поля в теле JSON.
Идентификатор вашей организации находится на экране ключей API в вашей панели управления, рядом с самим ключом. Это один и тот же идентификатор для каждого вашего запроса.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
curl -X POST https://api.zinndigital.com/v1/platform-transfers \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "source_platform": <string>, "target_platform": <string>, "source_url": <string>, "entity_count": <integer> }'Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли
Подробнее
Creates the request in `draft`. **No money moves here** — call `payPlatformTransfer` to charge it. The row is written before the charge on purpose: a declined card then leaves a visible `payment_failed` transfer rather than a charge for a job nobody can see. Requires `billing.view`.
Тело запроса
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
source_platform | string | Да | — |
target_platform | string | Да | — |
source_url | string | Да | — |
entity_count | integer | Да | — |
target_site_id | object | Нет | Where it lands. May be omitted — a customer often buys the transfer before the destination site exists, which is the point of an on-ramp. |
customer_note | string | Нет | — |
org_id | object | Нет | — |
Ответ
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
id | Uuid | Да | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
source_platform | string | Да | — |
source_platform_name | string | Нет | — |
target_platform | string | Да | — |
target_platform_name | string | Нет | — |
source_url | string | Да | — |
target_site_id | object | Нет | — |
tier_code | string | Да | — |
tier_name | string | Нет | — |
entity_count_estimate | integer | Нет | — |
status | PlatformTransferStatus | Да | — |
status_label | string | Нет | — |
price_amount_minor | integer | Да | — |
price_currency | string | Да | — |
redirects_mapped | boolean | Нет | — |
redirect_count | integer | Нет | — |
canonicals_verified | boolean | Нет | — |
sitemap_submitted | boolean | Нет | — |
structured_data_preserved | boolean | Нет | — |
seo_checks_complete | boolean | Нет | — |
customer_note | string | Нет | — |
sla_due_at | object | Нет | — |
created_at | string | Да | — |
completed_at | object | Нет | — |
events | PlatformTransferEvent[] | Нет | The customer-visible trail only. Staff notes name vendors and what a job cost us, and never appear here. |
Ошибки, которые может возвращать этот эндпоинт
401 · 403 · 404 · 422 · 429