platform-transfers
POST /v1/platform-transfers
Book a platform transfer (nothing is charged yet).
احراز هویت
یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز 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