# مستندات عمومی API

Source: https://iliya.me/api-docs
Language: fa-IR

وب‌سایت یا CMS شما می‌تواند محتوا را با یک قالب کمپین آماده به مقصدهای ایلیا ارسال کند.

راهنمای اتصال و نمونه‌های امضا را بدون ورود بخوانید. استفاده از API همچنان به حساب مجاز و کلید دسترسی نیاز دارد.

## بررسی اتصال

GET /api/v1/publishing/connection/

## فهرست قالب‌ها

GET /api/v1/publishing/catalog/templates/

## بارگذاری رسانه

POST /api/v1/publishing/media/

## وضعیت رسانه

GET /api/v1/publishing/media/{media\_id}/

## ایجاد انتشار

POST /api/v1/publishing/campaigns/

## وضعیت انتشار

GET /api/v1/publishing/requests/{request\_id}/

هر درخواست با HMAC-SHA256، زمان، nonce و هش دقیق بدنه امضا می‌شود.

کلید محرمانه فقط همین یک بار نمایش داده می‌شود؛ آن را در محل امن نگه دارید.

اعتبارنامه و کلید محرمانه را فقط در سرور یا بک‌اند CMS نگه دارید؛ آن‌ها را در جاوااسکریپت عمومی مرورگر قرار ندهید.

رشتهٔ زیر را دقیقاً با نویسهٔ خط جدید LF بسازید. مسیر باید همان مسیر درخواست و هش بدنه باید SHA-256 بایت‌های دقیق بدنه باشد.

کلید HMAC برابر SHA-256 بایت‌های UTF-8 کلید محرمانه است و امضا به‌صورت hex کوچک ارسال می‌شود.

برای بخش مجاز، یک قالب کمپین فعال با مقصدهای قابل استفاده بسازید.

درخواست POST باید JSON با HTML پالایش‌شدهٔ سازگار با کمپین و URL عمومی HTTPS رسانه داشته باشد.

پاسخ موفق 202 Accepted است. شناسهٔ درخواست و status\_url را برای پیگیری نگه دارید.

محدودیت‌های فعلی و انواع رسانهٔ مجاز از نقطهٔ پایانی اتصال با درخواست امضاشده دریافت می‌شوند و به حساب و طرح شما وابسته‌اند.

در V1 رسانه با سیاست پردازش پیش‌فرض ایلیا آماده می‌شود؛ کنترل دستی کیفیت یا فشرده‌سازی وجود ندارد و حفظ دقیق بایت‌های منبع تضمین نمی‌شود.

محدودیت بسته و سقف ارسال روزانه همچنان اعمال می‌شود. شکست دریافت یا پردازش هر رسانه از ارسال ناقص کمپین جلوگیری می‌کند.

## 202

عملیات پذیرفته شد یا نتیجهٔ همان کلید هم‌توانی بازگردانده شد.

## 400

بدنه، قالب، مقصد یا URL رسانه نامعتبر است.

## 401

امضا، زمان، nonce یا اعتبارنامه معتبر نیست.

## 403

بسته، زمینهٔ حساب یا بخش اجازهٔ استفاده ندارد.

## 404

درخواست در محدودهٔ این اعتبارنامه وجود ندارد.

## 409

کلید هم‌توانی قبلاً با بدنهٔ دیگری استفاده شده است.

## 413

بدنهٔ درخواست از حد مجاز بزرگ‌تر است؛ فایل راه‌دور بزرگ در وضعیت عملیات با REMOTE\_MEDIA\_TOO\_LARGE شکست می‌خورد.

## 429

محدودیت نرخ اعمال شده؛ مقدار Retry-After را رعایت کنید.

## 503

صف یا سامانهٔ مشترک محدودسازی نرخ در دسترس نیست.