hosting
GET /v1/sites/{siteId}/preview-urls
Get the URLs at which a site can be viewed before its DNS resolves.
توثيقِ شناخت
ایک بیرر ٹوکن کے طور پر ایک API کی بھیجیں۔ کی کے پاس sites.view اجازت ہونی چاہیے؛ اس کے بغیر کی کو 404 کے بجائے 403 کے ساتھ مسترد کر دیا جاتا ہے۔
یہ اینڈ پوائنٹ کوئی آرگنائزیشن آئی ڈی نہیں لیتا۔ آپ کی کلید پہلے ہی اس آرگنائزیشن کی شناخت کرتی ہے جس سے یہ تعلق رکھتی ہے، اور اس کا جواب اسی کے مطابق محدود ہوتا ہے۔
آزمائیں
کوئی بھی چیز جو زاویہ دار قوسین میں ہو اسے اپنی اقدار سے بدلیں، اور کلیدی پلیس ہولڈر کو اپنے ڈیش بورڈ کی کسی کلید سے بدلیں۔
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/preview-urls \
-H "Authorization: Bearer zdk_live_…"لاگ ان ہیں؟ آپ کے ڈیش بورڈ میں موجود API کنسول آپ کی حقیقی تنظیم کی آئی ڈی اور آپ کی اپنی کلید خود بخود پُر کر دیتا ہے، اور لائیو API پر درخواست چلاتا ہے تاکہ آپ اصل ردعمل دیکھ سکیں۔ اس اینڈ پوائنٹ کو API کنسول میں کھولیں
تفصیلات
How a customer sees their site **before** they point their domain at us — the "temporary URL" the product has advertised on both lines since the first feature matrix (docs/37) and the import flow tells them to use ("Check it over, then point your domain at us"). Requires `sites.view`. Every hostname is **read from the hosting platform, never derived**: they are not uniformly `<label>.<preview-domain>` and a formula produces confidently wrong links (one live package answers with a datacentre label in the middle of the hostname). `vendor_branded` marks a URL whose hostname is not under our configured preview domain — a docs/62 §3.7 breach. Such a URL is reported so staff can see it, and **must not be offered to a customer** by any client. A site with no preview URL returns `200` with an empty `urls` and a machine-readable `unavailable_reason` — that is an answer, not an error, and it is the answer for a site on our own fleet (`unsupported_driver`) as well as for a hosted site the vendor issued nothing for (`none_issued`). ⛔ A fleet site is deliberately **not** a `404` here, unlike the `/hosting/*` reads: a vendor package is a property of the vendor, so a site without one has no such resource, but a preview URL is a property of the site and "this platform cannot mint one yet" is something the customer is owed.
پیرامیٹرز
| نام | قسم | لازمی | یہ کیا ہے |
|---|---|---|---|
siteId (path) | Uuid | ہاں | Site ID (UUIDv7). |
جواب
| نام | قسم | لازمی | یہ کیا ہے |
|---|---|---|---|
urls | SitePreviewUrl[] | ہاں | Every preview URL the platform serves for this site. |
unavailable_reason | string<, unsupported_driver, none_issued> | ہاں | Why there is no usable preview URL, blank when there is one. A stable machine identifier the client localises — never display text. |
وہ خرابیان جو یہ اینڈ پوائنٹ واپس کر سکتا ہے
401 · 403 · 404 · 429 · 503