platform-transfers
POST /v1/platform-transfers
Book a platform transfer (nothing is charged yet).
Authentification
Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation billing.view ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.
Où insérer l'ID de votre organisation
Cet endpoint prend org_id comme champ dans le corps JSON.
L'identifiant de votre organisation se trouve sur l'écran des clés API de votre tableau de bord, à côté de la clé elle-même. Il s'agit du même identifiant pour chaque appel que vous effectuez.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
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> }'Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
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`.
Corps de la requête
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
source_platform | string | Oui | — |
target_platform | string | Oui | — |
source_url | string | Oui | — |
entity_count | integer | Oui | — |
target_site_id | object | Non | 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 | Non | — |
org_id | object | Non | — |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
id | Uuid | Oui | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
source_platform | string | Oui | — |
source_platform_name | string | Non | — |
target_platform | string | Oui | — |
target_platform_name | string | Non | — |
source_url | string | Oui | — |
target_site_id | object | Non | — |
tier_code | string | Oui | — |
tier_name | string | Non | — |
entity_count_estimate | integer | Non | — |
status | PlatformTransferStatus | Oui | — |
status_label | string | Non | — |
price_amount_minor | integer | Oui | — |
price_currency | string | Oui | — |
redirects_mapped | boolean | Non | — |
redirect_count | integer | Non | — |
canonicals_verified | boolean | Non | — |
sitemap_submitted | boolean | Non | — |
structured_data_preserved | boolean | Non | — |
seo_checks_complete | boolean | Non | — |
customer_note | string | Non | — |
sla_due_at | object | Non | — |
created_at | string | Oui | — |
completed_at | object | Non | — |
events | PlatformTransferEvent[] | Non | The customer-visible trail only. Staff notes name vendors and what a job cost us, and never appear here. |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404 · 422 · 429