Delivery API

Delivery API به شما اطلاعاتی در مورد نحوه “ارائه یک درخواست” می گوید. این API ستون فقرات است که یک وبلاگ را در یک زیر شاخهمیزبانی می کند.

API نقطه پایانی: https://blog.taptik.ir/api/delivery/v0/{subdomain}

زیر دامنه وبلاگ خود را جایگزین {subdomain} کنید.

درخواست

  • درخواست GET به نقطه پایانی API
  • پارامتر پرس و جو api_key را روی یک کلید معتبر Delivery API تنظیم کنید. می‌توانید یکی را در تنظیمات → API کلیدهایایجاد کنید.
  • پارامتر پرس و جو path را در مسیر وبلاگی که می خواهید اطلاعاتی درباره آن دریافت کنید، تنظیم کنید. برای مثال، اگر می‌خواهید اطلاعاتی درباره https://myblog.com/hello-world به دست آورید، path را روی /hello-world/ تنظیم کنید.

پاسخ

یک پاسخ موفق یکی از اشیاء JSON زیر خواهد بود:

1. فایل

زمانی که مسیر یک فایل باشد، این شی برگردانده می شود.

{
	"type": "file",
	"at": 1661590503,
	"cache": true,
	"status": 200,
	"file_type": "template",
	"content": "SGVsbG8gV29ybGQ=",
	"mime_type": "text/html",
	"cache_control": "no-cache, private"
}

2. تغییر مسیر

زمانی که مسیر یک تغییر مسیر باشد، این شی برگردانده می شود.

{
	"type": "redirect",
	"at": 1661590503,
	"cache": true,
	"status": 301,
	"to": "https://example.com"
}

خواص رایج:

کلید
نوع
توضیحات
type
string
file یا redirect
at
integer
زمانی که شیء ایجاد شد، مهر زمانی یونیکس را نشان می‌دهد
cache
boolean
اینکه آیا شیء پاسخ باید در سرورهای پراکسی/واسطه ذخیره شود یا خیر. false برای مسیرهای پیش نمایش پست.
status
integer
کد وضعیت پاسخ HTTP . می تواند 200 ، 301 ، 302 یا 404.

ویژگی های فایل:

کلید
نوع
توضیحات
file_type
string
template ، asset ، یا media
content
string
محتوای کدگذاری شده Base64 فایل
mime_type
string
Mime نوع فایل (برای هدر نوع محتوا)
cache_control
string
مقدار هدر HTTP Cache-Control

ویژگی های تغییر مسیر:

کلید
نوع
توضیحات
to
string
URL برای تغییر مسیر به