Authentification
Envoyez une clé d'API en tant que jeton du porteur (bearer token). Cet endpoint n'indique pas de permission spécifique dans la spécification, attribuez donc à votre clé le minimum requis et vérifiez la réponse plutôt que de faire des suppositions.
Où insérer l'ID de votre organisation
Cet point de terminaison prend org_id comme paramètre de requête. Omettez-le et l'appel couvrira l'ensemble de votre sous-arbre de location ; envoyez-le pour restreindre l'appel à une seule organisation.
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/content/link-sets \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'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
Gated on `links.edit`. Shares are optional: leave every one blank and the links rotate evenly; set some and the rest share what is left. A set whose shares cannot be resolved is refused with a sentence naming the total, not a code.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
org_id (query) | string | Non | — |
Corps de la requête
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
name | string | Non | — |
notes | string | Non | — |
is_archived | boolean | Non | — |
entries | LinkSetEntry[] | Non | — |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
id | string | Oui | — |
name | string | Oui | — |
notes | string | Oui | — |
is_archived | boolean | Oui | An archived set is hidden from the picker and takes no new recipes; the recipes already using it keep working. Archiving is offered where deleting is refused. |
entries | LinkSetEntry[] | Oui | — |
created_at | string | Oui | — |
updated_at | string | Oui | — |
recipe_count | integer | Oui | How many recipes point at this set — so a delete button can say so first. |
distribution | object[] | Oui | The resolved share of every (URL, wording) pair, summing to 100 — what will actually happen. Computed by the same function a run uses. |
distribution_error | string | Oui | Why there is no distribution, or empty. Separate from `distribution` because an empty list also means "this set has no links", and one value for two facts is not an answer. |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 422