Pengesahan
Hantar kunci API sebagai token pembawa. Titik akhir ini tidak menyatakan kebenaran tertentu dalam spesifikasi, jadi berikan kunci anda kebenaran minimum yang diperlukan dan semak respons tersebut daripada membuat andaian.
Tempat ID organisasi anda diletakkan
Titik akhir ini mengambil org_id sebagai parameter pertanyaan. Biarkan ia kosong dan panggilan tersebut meliputi keseluruhan subpohon penyewaan anda; hantarkannya untuk mengecilkan panggilan kepada satu organisasi.
ID organisasi anda terletak pada skrin kekunci API dalam papan pemuka anda, di sebelah kekunci itu sendiri. Ia adalah ID yang sama dalam setiap panggilan yang anda buat.
Cuba
Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka anda.
curl -X POST https://api.zinndigital.com/v1/content/link-sets \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Sudah log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API
Butiran
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.
Parameter
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
org_id (query) | string | Tidak | — |
Badan permintaan
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
name | string | Tidak | — |
notes | string | Tidak | — |
is_archived | boolean | Tidak | — |
entries | LinkSetEntry[] | Tidak | — |
Respons
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
id | string | Ya | — |
name | string | Ya | — |
notes | string | Ya | — |
is_archived | boolean | Ya | 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[] | Ya | — |
created_at | string | Ya | — |
updated_at | string | Ya | — |
recipe_count | integer | Ya | How many recipes point at this set — so a delete button can say so first. |
distribution | object[] | Ya | 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 | Ya | 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. |
Ralat yang boleh dikembalikan oleh titik akhir ini
401 · 403 · 422