استعلامات المرجع (القوالب، والمظاهر، والعملات، والموسيقى)

ما الذي يمكنك فعله

تُعيد أربع نقاط نهاية للقراءة فقط قوائم المرجع التي تعتمد عليها عند ضبط كتيّب. تسرد كلٌّ منها الخيارات الصالحة لإعداد محدّد، كي تختار مُعرّفًا أو اسمًا من القائمة وتمرّره إلى نقطة الكتابة المطابقة:

• اسرد القوالب — قوالب الكتيّبات القابلة لإعادة الاستخدام المحفوظة في حسابك.
• اسرد المظاهر — مظاهر/سِمات العارض المتاحة، كلٌّ منها مع رابط خلفيته المضمَّنة.
• اسرد العملات — العملات المتاحة عند بيع كتيّب.
• اسرد موسيقى الخلفية — مقاطع موسيقى الخلفية المدمجة التي يمكنك إرفاقها بعارض كتيّب.

قبل أن تبدأ

• صادِق بمفتاح API الخاص بك — يُرسَل إمّا في ترويسة X-Api-Key أو ضمن Authorization: Bearer YOUR_API_KEY.
• الرابط الأساسي: https://go.fliplink.me.
• هذه استعلامات GET بلا جسم طلب ولا معطيات مسار — وتُمرَّر الخيارات بوصفها سلاسل استعلام حيثما أُشير.

اسرد القوالب

يسرد قوالب الكتيّبات القابلة لإعادة الاستخدام المحفوظة في حسابك. صفِّ عبر DocType. استخدم مُعرّف قالب مع مسارات save-as-template / create.

curl -X GET 'https://go.fliplink.me/api/list-templates?DocType=0' \
  -H 'X-Api-Key: YOUR_API_KEY'

الاستجابة:

{
  "Result": "OK",
  "Items": [
    {
      "ID": -1,
      "Name": "- Blank Template - "
    }
  ]
}

يقبل معطى الاستعلام DocType القيمة 0 = كتيّب (الافتراضي) أو 1 = مستند.

اسرد المظاهر

يسرد مظاهر/سِمات العارض المتاحة؛ ويحمل كل صفّ رابط خلفية المظهر المضمَّنة. استخدم Name المظهر مع set-skin.

curl -X GET 'https://go.fliplink.me/api/list-skins?Type=false' \
  -H 'X-Api-Key: YOUR_API_KEY'

الاستجابة:

{
  "Result": "OK",
  "Items": [
    {
      "ID": -1,
      "Name": "Light Wood",
      "ImageURL": "https://af203091.s3.us-east-1.amazonaws.com/docs/background/1.webp",
      "ThumbURL": "https://af203091.s3.us-east-1.amazonaws.com/docs/background/thumb/1.webp"
    }
  ]
}

معطى الاستعلام Type قيمة boolean: false = مظاهر الكتيّبات، true = مظاهر المستندات.

اسرد العملات

يسرد العملات المتاحة عند بيع كتيّب (لإعدادات البيع/الدفع).

curl -X GET 'https://go.fliplink.me/api/list-currencies' \
  -H 'X-Api-Key: YOUR_API_KEY'

الاستجابة:

{
  "Result": "OK",
  "Items": [
    {
      "Name": "AED"
    }
  ]
}

اسرد موسيقى الخلفية

يسرد مقاطع موسيقى الخلفية المدمجة التي يمكنك إرفاقها بعارض كتيّب.

curl -X GET 'https://go.fliplink.me/api/list-background-music' \
  -H 'X-Api-Key: YOUR_API_KEY'

الاستجابة:

{
  "Result": "OK",
  "Items": [
    {
      "Name": "None",
      "FileURL": ""
    }
  ]
}

الأخطاء المحتملة

• مفتاح API مفقود أو غير صالح ← HTTP 401. تُعيد هذه الحالة صفحة HTML عادية لعدم التصريح — دون أي جسم JSON. وينطبق ذلك على نقاط النهاية الأربع جميعها.