صور الغلاف والمعاينة
العلامة التجارية والمحتوىحدّد ملف PDF للمعاينة الذي يراه القرّاء قبل التقاط العملاء المحتملين أو الدفع، وملف PDF المكوَّن من صور فقط المُستخدَم للصور المصغّرة والمعاينات، عبر الـ API.
الواجهات المُستخدَمة في هذا النقاش
ما الذي يمكنك فعله
تتحكّم نقطتا نهاية للكتابة في ملفات PDF التي تنوب عن الكتيّب قبل أن يحصل القارئ على وصول كامل:
- حدّد ملف PDF للمعاينة المعروض للقرّاء قبل التقاط العملاء المحتملين / الدفع.
- حدّد ملف PDF المكوَّن من صور المُستخدَم للصور المصغّرة والمعاينات.
يستهدف كل استدعاء كتيّبًا واحدًا عبر {flipbookId} الخاص به ويُعيد نتيجة نجاح بسيطة.
قبل أن تبدأ
ستحتاج إلى:
- مفتاح API — يُرسَل في ترويسة
X-Api-Key، أو ضمنAuthorization: Bearer YOUR_API_KEY، مع كل طلب. - الـ
{flipbookId}— المُعرّف الرقمي للكتيّب/المستند، الذي يُعيده create-by-file / create-by-url (بوصفهID) أو تُعيده list. - تذهب جميع الطلبات إلى الرابط الأساسي
https://go.fliplink.me.
تأخذ نقطتا النهاية كلتاهما جسمًا بصيغة form-urlencoded (لا JSON).
حدّد ملف PDF للمعاينة
يحدّد PUT /api/set-preview-pdf/{flipbookId} ملف PDF للمعاينة المعروض للقرّاء قبل التقاط العملاء المحتملين / الدفع. ويُمسح تلقائيًا إذا كان كلٌّ من التقاط العملاء المحتملين ووضع البيع مُطفأً.
أرسِل رابط ملف PDF المراد استخدامه بوصفه PreviewPDF:
PreviewPDF— رابط ملف PDF المراد عرضه كمعاينة. تُخزَّن القيمة كما هي؛ ولا يتحقّق الـ API من أن الرابط قابل للوصول (مُختبَر حيًّا)، لذا أرسِل رابط PDF صالحًا وقابلًا للوصول. والافتراضي فارغ (لا ملف PDF للمعاينة).
curl -X PUT 'https://go.fliplink.me/api/set-preview-pdf/96216' \
-H 'X-Api-Key: YOUR_API_KEY' \
--data-urlencode 'PreviewPDF=https://go.fliplink.me/files/preview.pdf'
الاستجابة:
{
"Result": "OK",
"Message": "Updated successfully"
}
حدّد ملف PDF للصور
يحدّد PUT /api/set-image-pdf/{flipbookId} ملف PDF المكوَّن من صور فقط / للمعاينة المُستخدَم للصور المصغّرة والمعاينات. أرسِل رابط ملف PDF المراد استخدامه بوصفه IMGPdf:
IMGPdf— رابط ملف PDF المكوَّن من صور فقط المراد استخدامه للصور المصغّرة والمعاينات. تُخزَّن القيمة كما هي؛ ولا يتحقّق الـ API من أن الرابط قابل للوصول (مُختبَر حيًّا)، لذا أرسِل رابط PDF صالحًا وقابلًا للوصول. والافتراضي عنصر نائب بلا صورة، وإرسال قيمة فارغة يُبقي ملف PDF للصور الحالي.
curl -X PUT 'https://go.fliplink.me/api/set-image-pdf/96216' \
-H 'X-Api-Key: YOUR_API_KEY' \
--data-urlencode 'IMGPdf=https://go.fliplink.me/files/pages.pdf'
الاستجابة:
{
"Result": "OK",
"Message": "Updated successfully"
}
الأخطاء المحتملة
- مفتاح API مفقود أو غير صالح ← HTTP
401. تُعيد هذه الحالة صفحة HTML عادية لعدم التصريح — دون أي جسم JSON. تحقّق من وجود ترويسةX-Api-Key(أوAuthorization: Bearer) وصحّتها. - مُعرّف العنصر غير موجود أو غير مملوك لمفتاحك ← HTTP
200معMessageبالقيمةItem not found. - حقل مجهول أو مكتوب خطأً في الجسم ← HTTP
200معMessageبالقيمةUnknown field(s) '…'. Expected: ….
ملاحظات
- في كلا الحقلين، تُخزَّن قيمة الرابط كما هي — فالـ API لا يتحقّق من أن ملف PDF قابل للوصول (مُختبَر حيًّا). أرسِل دائمًا رابط PDF صالحًا وقابلًا للوصول.
- ملف PDF للمعاينة (
PreviewPDF) يكون افتراضيًا فارغًا ويُمسح تلقائيًا إذا كان كلٌّ من التقاط العملاء المحتملين ووضع البيع مُطفأً. - ملف PDF للصور (
IMGPdf) يكون افتراضيًا عنصرًا نائبًا بلا صورة؛ وإرسال قيمة فارغة يُبقي ملف PDF للصور الحالي.