platform-transfers
POST /v1/platform-transfers
Book a platform transfer (nothing is charged yet).
認証
ベアラー トークンとして API キーを送信します。キーには billing.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
組織 ID を入力する場所
このエンドポイントは、JSONボディのフィールドとして org_id を受け取ります。
組織IDは、ダッシュボードのAPIキー画面にキーのすぐ横に表示されています。これは、実行するすべての呼び出しで同じIDになります。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
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コンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブ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