برای استفاده از وب‌سرویس purge ابر آروان، ابتدا نیاز به احراز هویت دارید. برای این منظور، API Key خود را در قسمت «Authorize» وارد کنید. اگر اطلاعی از API Key خود ندارید می‌توانید راهنمای چگونه API Key یا کلید دسترسی برنامه‌نویسی بسازید؟ را مطالعه کنید.
عملکرد API حذف اطلاعات Cache شده، به دو شکل کلی زیر است:
- پاک کردن تمامی فایل‌ها
- پاک کردن گزینشی فایل‌ها
پاک کردن تمامی فایل‌ها (Purge ALL)
برای استفاده از این سرویس از نشانی زیر استفاده کنید :
https://api.arvancloud.ir/cdn/4.0/domains/{{Domain}}/caching
پارامترهای مورد نیاز این متد عبارت‌اند از:
Method: DELETE Params: Purge = all Protocol = array (http,https) Domains =array (
www.test.com,test.com,a.test.com
)
اطلاعات قسمت هدر این متد نیز عبارت‌اند از :
Accept: application/json Accept-Language: fa Authorization : API KEY (در بالا روش دریافت توضیح داده شده است )
نمونه خروجی موفق این API:
{
"message": "درخواست پاک‌سازی با موفقیت صادر شد."
}
پاک کردن گزینشی فایل‌ها
برای استفاده از این متد باز هم از همان نشانی گفته شده در ابتدای این راهنما استفاده می‌شود، اما پارامترهای ورودی آن به شرح زیر است:
Method: DELETE Params: purge_url = array (نشانی فایل‌های مورد نیاز برای پاک شدن)
در قسمت هدر این متد نیز اطلاعات زیر قرار می‌گیرد:
Accept: application/json Accept-Language: fa Authorization : API KEY
(در بالا روش دریافت توضیح داده شده است)
نمونه خروجی موفق این API:
{
“message”: “درخواست پاک‌سازی با موفقیت صادر شد.”
}