Where is the API documentation?

PocketBase's API follows REST conventions and is documented at pocketbase.io/docs — the collections, authentication flows, and filter syntax all apply directly to your VeloCMS tenant's backend. For SaaS tenants, your PocketBase URL is displayed in Admin → Settings → Developer → API Access. For self-hosted tenants, your PocketBase instance is accessible at the URL configured during setup (typically the same hostname as your blog at port 8090, or a subdomain like data.yourdomain.com depending o...

How do I authenticate API requests?

Generate an API token in Admin → Settings → Developer → API Tokens. Click New Token, give it a name (for example 'Zapier integration' or 'migration script'), select the permission scopes you need (read-only posts, read-write posts, read members, etc.), and save. The token is shown once — copy it immediately because it's hashed before storage and VeloCMS can't display it again. Include the token in the Authorization header of your requests as 'Bearer your-token-here'. Tokens can be revoked ind...

Which collections are available through the API?

Your tenant's PocketBase exposes collections for posts (the main blog posts including drafts), media (uploaded files and their metadata), blog_members (your reader accounts), site_settings (theme, domain, analytics configuration), and tags. Ecommerce tenants also have collections for products, orders, and product_variants. The API token's permission scopes determine which collections your token can access — a read-only token scoped to posts can't accidentally modify your member list or site s...

What are good use cases for the VeloCMS API?

The API enables a wide range of scenarios that aren't possible through the admin UI alone. Content migration tools can create posts in bulk from a JSON or CSV export of another platform. Headless front-end deployments can fetch posts via API and render them in a completely custom React or Next.js template without using VeloCMS's built-in themes. Static site generators like Astro or Eleventy can pull VeloCMS posts at build time to generate a fully static site. Automation scripts can publish po...

كيف أصل إلى واجهة برمجة التطبيقات (API) الخاصة بـ VeloCMS؟

API الخاص بـ VeloCMS مبنيّ على PocketBase، الذي يوفّر REST API موثّقًا توثيقًا كاملًا على عنوان URL الخاص بـ PocketBase لمستأجرك. للوصول إليه، أنشئ توكن API من Admin → Settings → Developer → API Tokens، وأدرج التوكن كترويسة Bearer في طلباتك، وستتمكّن حينئذٍ من قراءة المنشورات والأعضاء والوسائط وإعدادات الموقع وكتابتها برمجيًا.

أين توجد وثائق API؟

تتّبع API الخاصة بـ PocketBase اصطلاحات REST وهي موثَّقة على pocketbase.io/docs — تنطبق المجموعات وتدفقات المصادقة وبنية الفلترة مباشرةً على الواجهة الخلفية لمستأجرك في VeloCMS. بالنسبة لمستأجري SaaS، يُعرض عنوان URL الخاص بـ PocketBase في Admin → Settings → Developer → API Access. أما المستأجرون ذاتيو الاستضافة، فيمكنهم الوصول إلى نسخة PocketBase الخاصة بهم على العنوان المُضبَط أثناء الإعداد — وعادةً ما يكون على المضيف ذاته للمدوّنة على المنفذ 8090، أو على نطاق فرعي مثل data.yourdomain.com بحسب طريقة النشر.

كيف أصادق على طلبات API؟

أنشئ توكن API من Admin → Settings → Developer → API Tokens. انقر New Token، وامنحه اسمًا واضحًا — مثلًا «تكامل Zapier» أو «سكريبت الهجرة» — واختر نطاقات الصلاحيات التي تحتاجها (منشورات للقراءة فحسب، أو قراءة وكتابة، أو قراءة الأعضاء... إلخ)، ثم احفظ. يُعرض التوكن مرّةً واحدة — انسخه فورًا، إذ يُخزَّن مُجزَّءًا بصيغة hash ولا يمكن لـ VeloCMS عرضه مجدّدًا. أدرج التوكن في ترويسة Authorization بصيغة 'Bearer your-token-here' في كل طلباتك. يمكن إلغاء أي توكن بصورة فردية من لوحة الإعدادات ذاتها دون التأثير على التوكنات الأخرى النشطة.

ما المجموعات المتاحة عبر API؟

تُتيح نسخة PocketBase الخاصة بمستأجرك مجموعاتٍ للمنشورات (منشورات المدوّنة الرئيسية بما فيها المسوّدات)، والوسائط (الملفات المرفوعة وبياناتها الوصفية)، و blog_members (حسابات القرّاء لديك)، و site_settings (السمة والنطاق وإعدادات التحليلات)، والوسوم. كما تحتوي نسخ التجارة الإلكترونية على مجموعات للمنتجات والطلبات و product_variants. تُحدّد نطاقات صلاحيات توكن API المجموعاتِ التي يمكن لتوكنك الوصول إليها — فتوكن القراءة فحسب المقيَّد بالمنشورات لن يستطيع تعديل قائمة الأعضاء أو إعدادات الموقع عن طريق الخطأ.

ما حالات الاستخدام الجيدة لـ API الخاصة بـ VeloCMS؟

تُتيح API طيفًا واسعًا من السيناريوهات التي لا يمكن تنفيذها عبر واجهة المشرف وحدها. فأدوات هجرة المحتوى قادرة على إنشاء منشورات بالجملة انطلاقًا من تصدير JSON أو CSV من منصة أخرى. أما نشرات الواجهات الأمامية بلا رأس (headless) فتجلب المنشورات عبر API وتصيّرها في قوالب React أو Next.js مخصصة كليًا بمعزل عن سمات VeloCMS المدمجة. ويمكن لمولّدات المواقع الساكنة مثل Astro أو Eleventy سحب منشورات VeloCMS في وقت البناء لتوليد موقع ساكن بالكامل. كما تستطيع السكريبتات الآلية نشر منشورات من قائمة انتظار محتوى، وتحديث بيانات وصف المنشورات استنادًا إلى بيانات التحليلات، أو مزامنة قوائم المشتركين مع منصات التسويق عبر البريد الإلكتروني. تجعل API من VeloCMS واجهة خلفية كاملة لنظام CMS بلا رأس، مع الإبقاء على المحرّر المُدار وواجهة النشر.

توكنات API التي تملك صلاحيات الكتابة تمنح الأنظمة الخارجية وصولًا مباشرًا إلى بيانات مدوّنتك. تعامل معها كلمات مرور — خزّنها في متغيرات البيئة لا في شيفرة المصدر، وأعد توليدها إن اشتبهت في كشفها. احذف توكنات التكاملات التي لم تعد تستخدمها.