REST API وردپرس چیست و چه کاربردهایی دارد؟ راهنمای کامل استفاده و مدیریت API

وردپرس فقط یک سیستم مدیریت محتوا برای ساخت صفحات و انتشار مقاله نیست؛ این سیستم امکاناتی دارد که به کمک آن‌ها می‌توان اطلاعات سایت را با نرم‌افزارها، اپلیکیشن‌ها و سرویس‌های دیگر تبادل کرد. یکی از مهم‌ترین این امکانات REST API وردپرس است. این رابط برنامه‌نویسی به توسعه‌دهندگان اجازه می‌دهد بدون نیاز به ورود مستقیم به پیشخوان وردپرس، از طریق درخواست‌های استاندارد HTTP به اطلاعات سایت دسترسی داشته باشند یا در صورت داشتن مجوز، آن‌ها را ایجاد و ویرایش کنند.

برای مثال، می‌توان با استفاده از REST API فهرست نوشته‌های سایت را در یک اپلیکیشن موبایل نمایش داد، محصولات فروشگاه ووکامرسی را در یک سامانه دیگر دریافت کرد، انتشار محتوا را از یک نرم‌افزار خارجی مدیریت کرد یا وردپرس را به یک وب‌سایت با فرانت‌اند مستقل متصل کرد.

در این مقاله از پرشیا وب، مفهوم REST API در وردپرس را از پایه توضیح می‌دهیم، ساختار درخواست‌ها و پاسخ‌ها را با مثال بررسی می‌کنیم و کاربردها، روش دسترسی، احراز هویت، امنیت و خطاهای رایج آن را شرح می‌دهیم.

REST API چیست؟

API مخفف عبارت Application Programming Interface و به معنی رابط برنامه‌نویسی کاربردی است. API مجموعه‌ای از قواعد و مسیرهای ارتباطی است که به دو نرم‌افزار اجازه می‌دهد اطلاعات را با یکدیگر تبادل کنند یا از قابلیت‌های یکدیگر استفاده کنند.

REST نیز مخفف Representational State Transfer است و به مجموعه‌ای از اصول معماری برای طراحی رابط‌های ارتباطی تحت وب اشاره دارد. در یک REST API، نرم‌افزارها معمولاً از طریق درخواست‌های HTTP به منابعی مانند نوشته‌ها، کاربران، محصولات یا سفارش‌ها دسترسی پیدا می‌کنند و داده‌ها را در قالبی ساختاریافته دریافت می‌کنند.

برای درک بهتر، یک فروشگاه اینترنتی را در نظر بگیرید که اطلاعات محصولات آن در وردپرس و ووکامرس ذخیره شده است. اگر بخواهید همین محصولات را در اپلیکیشن موبایل نمایش دهید، لازم نیست تمام اطلاعات را دوباره در اپلیکیشن وارد کنید. اپلیکیشن می‌تواند با ارسال درخواست به API فروشگاه، اطلاعات موردنیاز را دریافت کند و به کاربران نشان دهد.

REST API وردپرس چیست؟

WordPress REST API یک رابط استاندارد برای ارتباط نرم‌افزارها و سرویس‌های دیگر با سایت وردپرسی است. این رابط به برنامه‌ها اجازه می‌دهد اطلاعات وردپرس را در قالب JSON دریافت کنند و با رعایت سطح دسترسی و مجوزهای لازم، اطلاعات جدیدی ایجاد کنند یا داده‌های موجود را تغییر دهند.

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

یکی از کاربردهای مهم REST API در خود وردپرس، ارتباط ویرایشگر بلوکی یا Gutenberg با داده‌های سایت است. به همین دلیل، REST API فقط ابزاری برای اتصال اپلیکیشن‌های خارجی نیست و بخشی از زیرساخت امکانات مدرن وردپرس محسوب می‌شود.

طبق مستندات رسمی وردپرس، این رابط می‌تواند برای ساخت تجربه مدیریتی اختصاصی، ایجاد فرانت‌اند مستقل و انتقال محتوای وردپرس به نرم‌افزارهای دیگر استفاده شود. راهنمای رسمی WordPress REST API جزئیات این قابلیت را توضیح می‌دهد.

REST API در وردپرس چگونه کار می‌کند؟

ارتباط با REST API معمولاً از طریق ارسال یک درخواست HTTP به آدرس مشخصی از سایت انجام می‌شود. وردپرس درخواست را دریافت می‌کند، مسیر و نوع عملیات را تشخیص می‌دهد، سطح دسترسی را بررسی می‌کند و در نهایت پاسخ را در قالب JSON برمی‌گرداند.

برای مثال، فرض کنید آدرس سایت شما https://example.com باشد. اگر بخواهید فهرست نوشته‌های عمومی سایت را دریافت کنید، می‌توانید این آدرس را در مرورگر باز کنید:

https://example.com/wp-json/wp/v2/posts

در این آدرس، بخش wp-json مسیر پایه REST API وردپرس و بخش wp/v2/posts مسیر دریافت نوشته‌ها است. اگر سایت شما از پیوندهای یکتای معمول استفاده کند، این ساختار به همین شکل در دسترس خواهد بود.

در پاسخ، وردپرس اطلاعات نوشته‌ها را به‌صورت JSON ارائه می‌کند. این اطلاعات می‌تواند شامل شناسه نوشته، عنوان، تاریخ انتشار، نامک، وضعیت انتشار، لینک صفحه و بخش‌هایی از محتوای آن باشد.

Screenshot 2017 02 20 01.23.08
Screenshot 2017 02 20 01.23.08

JSON چیست و چرا در REST API استفاده می‌شود؟

JSON مخفف JavaScript Object Notation است و یک قالب متنی برای ذخیره و انتقال داده‌های ساختاریافته محسوب می‌شود. این قالب به دلیل خوانایی مناسب و پشتیبانی در زبان‌های برنامه‌نویسی مختلف، برای تبادل اطلاعات میان نرم‌افزارها بسیار رایج است.

یک پاسخ ساده JSON ممکن است به شکل زیر باشد:

{
  "id": 125,
  "date": "2026-11-08T08:30:00",
  "slug": "wordpress-rest-api",
  "status": "publish",
  "type": "post",
  "title": {
    "rendered": "REST API وردپرس چیست؟"
  },
  "link": "https://example.com/wordpress-rest-api/"
}

این نمونه فقط برای نمایش ساختار JSON است و پاسخ واقعی هر نوشته ممکن است فیلدهای بیشتری داشته باشد. برای مثال، اطلاعات نویسنده، دسته‌بندی‌ها، تصویر شاخص و محتوای نوشته نیز می‌توانند در پاسخ API قرار بگیرند.

مسیرها، Endpoint و متدهای HTTP در REST API وردپرس

برای استفاده از REST API باید با چند مفهوم اصلی آشنا باشید. مهم‌ترین آن‌ها Route، Endpoint و HTTP Method هستند.

Route چیست؟

Route یا مسیر، آدرسی است که برای دسترسی به یک منبع یا مجموعه‌ای از منابع API استفاده می‌شود. برای مثال، مسیر /wp/v2/posts برای دسترسی به نوشته‌های وردپرس در نظر گرفته شده است.

Endpoint چیست؟

Endpoint عملیاتی است که روی یک مسیر مشخص اجرا می‌شود. یک Route می‌تواند چند Endpoint داشته باشد و نوع درخواست HTTP مشخص می‌کند کدام عملیات اجرا شود.

برای مثال، مسیر زیر را در نظر بگیرید:

https://example.com/wp-json/wp/v2/posts/125

ارسال درخواست GET به این مسیر اطلاعات نوشته شماره ۱۲۵ را دریافت می‌کند؛ درحالی‌که درخواست PUT یا POST با مجوز مناسب می‌تواند برای به‌روزرسانی آن استفاده شود و DELETE برای حذف نوشته کاربرد دارد.

متدهای مهم HTTP در REST API

متدکاربردنمونه عملیات در وردپرس
GETدریافت اطلاعاتمشاهده نوشته‌ها یا اطلاعات یک برگه
POSTایجاد منبع جدید یا اجرای عملیات تعریف‌شدهایجاد نوشته جدید
PUTبه‌روزرسانی یک منبعویرایش اطلاعات یک نوشته
PATCHبه‌روزرسانی بخشی از اطلاعاتتغییر عنوان یا وضعیت یک منبع
DELETEحذف منبعحذف یک نوشته با داشتن مجوز لازم

در عمل، پشتیبانی از هر متد به Endpoint موردنظر و تنظیمات آن بستگی دارد. همچنین استفاده از متدهای تغییردهنده اطلاعات به احراز هویت و مجوز کافی نیاز دارد.

مهم‌ترین Endpoint های پیش‌فرض REST API وردپرس

وردپرس برای بخش‌های مختلف سایت مسیرهای آماده‌ای ارائه می‌کند. این مسیرها به توسعه‌دهندگان اجازه می‌دهند بدون نوشتن API از ابتدا، اطلاعات موردنیاز را دریافت یا مدیریت کنند.

منبعمسیر APIکاربرد
نوشته‌ها/wp/v2/postsدریافت و مدیریت نوشته‌ها
برگه‌ها/wp/v2/pagesدریافت و مدیریت برگه‌ها
دسته‌بندی‌ها/wp/v2/categoriesدریافت و مدیریت دسته‌بندی‌ها
برچسب‌ها/wp/v2/tagsدریافت و مدیریت برچسب‌ها
رسانه‌ها/wp/v2/mediaدریافت و مدیریت فایل‌های رسانه‌ای
دیدگاه‌ها/wp/v2/commentsدریافت و مدیریت دیدگاه‌ها
کاربران/wp/v2/usersدسترسی مجاز به اطلاعات کاربران
جست‌وجو/wp/v2/searchجست‌وجو در منابع قابل جست‌وجو
انواع نوشته/wp/v2/typesدریافت انواع محتوای ثبت‌شده

توجه کنید که قابل مشاهده بودن یک مسیر به معنی دسترسی آزاد به تمام اطلاعات آن نیست. اطلاعات عمومی معمولاً بدون ورود قابل دریافت هستند، اما مشاهده یا تغییر اطلاعات خصوصی و انجام عملیات مدیریتی به مجوز مناسب نیاز دارد. همچنین برخی مسیرها ممکن است به دلیل تنظیمات سایت یا افزونه‌ها محدود شده باشند.

فهرست مسیرهای موجود در هر سایت را می‌توان از آدرس پایه API مشاهده کرد:

https://example.com/wp-json/

این آدرس اطلاعاتی درباره Namespaceها و مسیرهای ثبت‌شده در سایت ارائه می‌کند. برای مشاهده مرجع کامل مسیرهای پیش‌فرض نیز می‌توانید به مستندات رسمی Endpointهای وردپرس مراجعه کنید.

REST API وردپرس چه کاربردهایی دارد؟

کاربرد REST API به دریافت اطلاعات محدود نیست. با استفاده از این رابط می‌توان وردپرس را به بخش‌های مختلف یک کسب‌وکار متصل کرد و فرایندهای محتوایی، فروش، مدیریت اطلاعات و ارتباط میان نرم‌افزارها را توسعه داد.

۱. اتصال وردپرس به اپلیکیشن موبایل

یکی از کاربردهای مهم REST API، ساخت اپلیکیشن موبایل متصل به وردپرس است. فرض کنید یک سایت خبری یا آموزشی دارید و می‌خواهید کاربران از طریق اپلیکیشن اندروید یا iOS به مقاله‌ها دسترسی داشته باشند.

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

۲. ساخت وب‌سایت Headless WordPress

در ساختار Headless WordPress، وردپرس نقش سیستم مدیریت محتوا یا Backend را بر عهده دارد، اما بخش نمایشی سایت با فناوری دیگری توسعه داده می‌شود. برای مثال، می‌توان محتوای وردپرس را از طریق REST API دریافت کرد و در یک فرانت‌اند مبتنی بر React، Next.js یا Vue نمایش داد.

در این مدل، مدیر سایت همچنان از پیشخوان وردپرس برای انتشار مقاله و مدیریت محتوا استفاده می‌کند، اما کاربران رابط کاربری طراحی‌شده با فناوری مستقل را مشاهده می‌کنند.

این روش برای پروژه‌هایی مناسب است که به رابط کاربری اختصاصی، معماری چندکاناله یا کنترل بیشتر بر فرانت‌اند نیاز دارند. البته پیاده‌سازی آن به دانش فنی بیشتری نیاز دارد و باید مواردی مانند سئو، رندر سمت سرور، کش، مدیریت مسیرها و پیش‌نمایش محتوا از ابتدا طراحی شوند.

01 WordPress REST API 1
01 WordPress REST API 1

۳. اتصال وردپرس به نرم‌افزارهای سازمانی و CRM

بسیاری از کسب‌وکارها از نرم‌افزارهای مدیریت ارتباط با مشتری (CRM)، حسابداری، انبارداری یا مدیریت سفارش استفاده می‌کنند. REST API می‌تواند بستری برای تبادل اطلاعات میان این نرم‌افزارها و سایت وردپرسی باشد.

برای مثال، اطلاعات یک فرم ثبت درخواست در سایت می‌تواند به سامانه CRM منتقل شود. همچنین امکان دارد اطلاعاتی مانند وضعیت سفارش، موجودی کالا یا مشخصات خدمات از نرم‌افزارهای دیگر دریافت و در سایت نمایش داده شود.

البته برای این نوع اتصال، فقط وجود API کافی نیست. باید ساختار داده‌ها، روش احراز هویت، مدیریت خطا، جلوگیری از ثبت تکراری اطلاعات و نحوه همگام‌سازی میان دو سامانه نیز مشخص شود.

۴. مدیریت و انتشار خودکار محتوا

با استفاده از REST API می‌توان انتشار و مدیریت محتوا را از طریق یک نرم‌افزار خارجی انجام داد. برای مثال، یک سامانه مدیریت محتوا می‌تواند عنوان، متن، دسته‌بندی و تصویر شاخص مقاله را به وردپرس ارسال کند و نوشته جدیدی ایجاد کند.

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

با این حال، انتشار خودکار محتوا نباید بدون کنترل کیفیت انجام شود. بررسی صحت اطلاعات، جلوگیری از محتوای تکراری، مدیریت تصاویر و کنترل وضعیت انتشار همچنان اهمیت دارد.

۵. اتصال ووکامرس به سامانه‌های فروش و انبارداری

در فروشگاه‌های اینترنتی مبتنی بر WooCommerce، API می‌تواند برای دریافت و مدیریت اطلاعات محصولات، سفارش‌ها، مشتریان، کوپن‌ها و برخی تنظیمات فروشگاه استفاده شود.

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

ووکامرس علاوه بر REST API مدیریتی، Store API را نیز برای قابلیت‌های سمت مشتری مانند سبد خرید و فرایند پرداخت ارائه می‌کند. این دو API کاربرد یکسانی ندارند؛ Store API برای تعاملات فروشگاهی سمت کاربر طراحی شده و نباید به‌عنوان راهی برای دسترسی به اطلاعات حساس سفارش‌ها و مشتریان استفاده شود.

برای جزئیات بیشتر، مستندات APIهای ووکامرس و راهنمای REST API ووکامرس را مطالعه کنید.

۶. نمایش محتوای وردپرس در چند وب‌سایت یا پلتفرم

گاهی یک مجموعه محتوایی در وردپرس مدیریت می‌شود، اما لازم است همان اطلاعات در چند وب‌سایت، پنل اختصاصی یا پلتفرم دیگر نیز نمایش داده شوند. REST API می‌تواند اطلاعات را از سایت مرکزی دریافت و در محیط‌های دیگر ارائه کند.

برای نمونه، یک مجموعه آموزشی می‌تواند اطلاعات دوره‌ها و مقاله‌های خود را در وردپرس نگهداری کند و از طریق API آن‌ها را در وب‌سایت اصلی، اپلیکیشن و پنل دانشجویان نمایش دهد.

۷. توسعه افزونه‌ها و قابلیت‌های اختصاصی وردپرس

توسعه‌دهندگان می‌توانند با استفاده از REST API قابلیت‌های اختصاصی برای وردپرس ایجاد کنند. برای مثال، یک افزونه ممکن است اطلاعات خاصی را از یک سرویس خارجی دریافت کند، داشبورد مدیریتی اختصاصی بسازد یا داده‌های یک نوع نوشته سفارشی را در اختیار برنامه‌های دیگر قرار دهد.

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

چگونه REST API وردپرس را فعال یا بررسی کنیم؟

در نسخه‌های جدید وردپرس، REST API به‌صورت پیش‌فرض در هسته سیستم وجود دارد و معمولاً نیازی به نصب یا فعال‌سازی افزونه جداگانه ندارد. با این حال، ممکن است تنظیمات امنیتی، افزونه‌ها، فایروال یا پیکربندی سرور دسترسی به بعضی مسیرها را محدود کرده باشند.

برای بررسی اولیه، مراحل زیر را انجام دهید:

  1. آدرس سایت خود را در مرورگر وارد کنید و در انتهای آن عبارت /wp-json/ را قرار دهید.
  2. بررسی کنید آیا صفحه‌ای حاوی اطلاعات ساختاریافته API نمایش داده می‌شود یا خیر.
  3. برای آزمایش دریافت نوشته‌های عمومی، مسیر /wp-json/wp/v2/posts را باز کنید.
  4. اگر پاسخ JSON دریافت کردید، مسیر عمومی API در دسترس است.
  5. اگر خطا دریافت کردید، وضعیت پیوندهای یکتا، افزونه‌های امنیتی، تنظیمات سرور و محدودیت‌های دسترسی را بررسی کنید.

اگر پیوندهای یکتای سایت روی حالت Plain قرار داشته باشند یا ساختار بازنویسی آدرس‌ها به‌درستی کار نکند، ممکن است مسیرهای معمول REST API در دسترس نباشند. در این شرایط، ابتدا تنظیمات Permalinks و پیکربندی سرور را بررسی کنید. در برخی پیکربندی‌ها، مسیر جایگزین مبتنی بر پارامتر rest_route نیز قابل استفاده است.

نمونه مسیر جایگزین برای دریافت نوشته‌ها:

https://example.com/?rest_route=/wp/v2/posts

چگونه اطلاعات نوشته‌ها را با REST API دریافت کنیم؟

یکی از ساده‌ترین روش‌های آشنایی با REST API، دریافت نوشته‌های عمومی سایت است. برای این کار کافی است درخواست GET را به مسیر نوشته‌ها ارسال کنید.

GET https://example.com/wp-json/wp/v2/posts

اگر فقط به یک نوشته مشخص نیاز دارید، شناسه آن را به انتهای مسیر اضافه کنید:

GET https://example.com/wp-json/wp/v2/posts/125

برای محدود کردن تعداد نتایج یا جست‌وجو در میان نوشته‌ها نیز می‌توانید از پارامترهای Query استفاده کنید.

پارامترهای کاربردی برای دریافت اطلاعات

پارامترکاربردنمونه
per_pageتعیین تعداد نتایج در هر صفحه?per_page=5
pageانتخاب شماره صفحه نتایج?page=2
searchجست‌وجو در محتوای قابل جست‌وجو?search=wordpress
categoriesمحدود کردن نتایج به دسته‌بندی مشخص?categories=4
orderbyتعیین معیار مرتب‌سازی?orderby=date
orderتعیین ترتیب صعودی یا نزولی?order=desc

برای مثال، آدرس زیر پنج نوشته از دسته‌بندی شماره ۴ را بر اساس تاریخ انتشار و به ترتیب نزولی دریافت می‌کند:

https://example.com/wp-json/wp/v2/posts?per_page=5&categories=4&orderby=date&order=desc

مقادیر قابل استفاده برای هر پارامتر به Endpoint موردنظر بستگی دارد. بنابراین برای استفاده دقیق‌تر باید مستندات همان منبع را بررسی کنید.

چگونه با REST API در وردپرس نوشته جدید ایجاد کنیم؟

دریافت نوشته‌های عمومی معمولاً بدون احراز هویت امکان‌پذیر است؛ اما ایجاد یا ویرایش نوشته نیازمند احراز هویت و داشتن مجوز لازم در وردپرس است. یکی از روش‌های متداول برای اتصال یک نرم‌افزار خارجی به سایت وردپرسی، استفاده از Application Passwords است.

برای ساخت رمز اختصاصی برنامه، ابتدا وارد پیشخوان وردپرس شوید و از مسیر Users و سپس Profile، بخش Application Passwords را بررسی کنید. در صورت پشتیبانی نسخه وردپرس و فعال بودن این قابلیت، می‌توانید برای نرم‌افزار موردنظر یک رمز اختصاصی ایجاد کنید.

این رمز با رمز اصلی ورود به پیشخوان یکسان نیست و می‌توان آن را به‌صورت مستقل لغو کرد. پس از ایجاد رمز، باید آن را به‌شکل امن در نرم‌افزار یا محیط سرور نگهداری کنید.

نمونه درخواست برای ایجاد یک نوشته جدید با استفاده از cURL:

curl --user "USERNAME:APPLICATION_PASSWORD" \
  --header "Content-Type: application/json" \
  --request POST \
  --data '{
    "title": "آموزش REST API وردپرس",
    "content": "این یک نوشته آزمایشی است.",
    "status": "draft"
  }' \
  https://example.com/wp-json/wp/v2/posts

در این مثال، درخواست POST برای ایجاد نوشته جدید استفاده شده است. عنوان و محتوای نوشته در قالب JSON ارسال می‌شوند و مقدار status روی draft قرار گرفته است؛ بنابراین نوشته به‌صورت پیش‌نویس ذخیره می‌شود.

برای انتشار مستقیم می‌توان مقدار status را به publish تغییر داد، اما حساب کاربری باید مجوز انتشار نوشته را داشته باشد. همچنین برای ارسال اطلاعاتی مانند تصویر شاخص، دسته‌بندی یا فیلدهای سفارشی باید پارامترهای مربوط به آن‌ها را مطابق مستندات API تنظیم کنید.

نکته امنیتی: نام کاربری و Application Password را در کدهای سمت مرورگر، فایل‌های عمومی یا مخزن کد منتشر نکنید. این اطلاعات باید در سمت سرور و در محل امن نگهداری شوند. برای اتصال‌های واقعی، استفاده از HTTPS ضروری است.

پیشنهاد مطالعه : محتوای تولیدشده توسط کاربر (UGC) چیست؟ 

چگونه Endpoint اختصاصی در وردپرس بسازیم؟

گاهی مسیرهای پیش‌فرض وردپرس پاسخ‌گوی نیاز پروژه نیستند. برای مثال، ممکن است بخواهید اطلاعات یک سیستم رزرو، امتیاز کاربران یا داده‌های اختصاصی یک افزونه را از طریق API در اختیار یک نرم‌افزار دیگر قرار دهید. در این شرایط می‌توانید Endpoint اختصاصی بسازید.

وردپرس برای ثبت مسیرهای اختصاصی تابع register_rest_route() را ارائه می‌کند. این تابع معمولاً داخل هوک rest_api_init فراخوانی می‌شود.

نمونه زیر یک Endpoint ساده ایجاد می‌کند که با ارسال درخواست GET، یک پیام آزمایشی برمی‌گرداند:

add_action( 'rest_api_init', function () {

    register_rest_route( 'persiaweb/v1', '/message', array(
        'methods'  => 'GET',
        'callback' => function () {
            return array(
                'message' => 'سلام، این پاسخ API اختصاصی وردپرس است.'
            );
        },
        'permission_callback' => '__return_true',
    ) );

} );

در این مثال، Namespace برابر persiaweb/v1 و مسیر اختصاصی برابر message است. پس از ثبت کد، Endpoint از آدرس زیر قابل دسترسی خواهد بود:

https://example.com/wp-json/persiaweb/v1/message

این نمونه فقط یک پاسخ عمومی و آزمایشی برمی‌گرداند. اگر Endpoint قرار است اطلاعات خصوصی را نمایش دهد یا عملیات تغییردهنده انجام دهد، نباید از دسترسی عمومی استفاده کنید. در چنین شرایطی باید تابع permission_callback سطح دسترسی کاربر را بررسی کند.

برای مثال، اگر قرار است فقط کاربران واردشده با قابلیت ویرایش نوشته‌ها به یک مسیر دسترسی داشته باشند، می‌توان از بررسی مجوز وردپرس استفاده کرد:

'permission_callback' => function () {
    return current_user_can( 'edit_posts' );
},

کدهای نمونه باید در قالب یک افزونه اختصاصی یا افزونه‌ای مانند Code Snippets و با رعایت اصول توسعه وردپرس قرار بگیرند. پیش از افزودن کد به سایت اصلی، از نسخه پشتیبان استفاده کنید و آن را در محیط آزمایشی بررسی کنید.

پیشنهاد مطالعه : صفحه فرود (Landing Page) چیست 

تفاوت REST API وردپرس با WooCommerce REST API چیست؟

وردپرس و ووکامرس هر دو API ارائه می‌کنند، اما منابع و کاربردهای آن‌ها یکسان نیستند. REST API اصلی وردپرس بیشتر برای مدیریت منابع هسته مانند نوشته‌ها، برگه‌ها، دسته‌بندی‌ها، رسانه‌ها و کاربران استفاده می‌شود.

در مقابل، WooCommerce REST API برای کار با داده‌های اختصاصی فروشگاه طراحی شده است؛ مانند محصولات، سفارش‌ها، مشتریان، کوپن‌ها و برخی تنظیمات فروشگاه.

ویژگیWordPress REST APIWooCommerce REST API
منابع اصلینوشته، برگه، دسته‌بندی، رسانه و کاربرانمحصول، سفارش، مشتری و کوپن
مسیر نمونه/wp-json/wp/v2/posts/wp-json/wc/v3/products
کاربردمدیریت محتوای عمومی و منابع هسته وردپرساتصال نرم‌افزارها به داده‌های فروشگاه
احراز هویتبسته به نوع عملیات و سطح دسترسیبرای بسیاری از عملیات مدیریتی از کلیدهای API استفاده می‌شود

برای استفاده از API مدیریتی ووکامرس، معمولاً باید از پیشخوان فروشگاه و بخش Advanced و سپس REST API کلیدهای دسترسی ایجاد کنید. این کلیدها به یک کاربر وردپرس متصل هستند و می‌توان برای آن‌ها سطح دسترسی خواندن، نوشتن یا هر دو را تعیین کرد.

در مقابل، Store API ووکامرس برای قابلیت‌های سمت مشتری مانند محصولات، سبد خرید و پرداخت کاربرد دارد و از نظر دسترسی و نوع اطلاعات با REST API مدیریتی متفاوت است. انتخاب API مناسب باید بر اساس نوع عملیات و حساسیت داده‌ها انجام شود.

امنیت REST API وردپرس؛ چه نکاتی را باید رعایت کنیم؟

REST API راهی برای ارتباط نرم‌افزارها با سایت است؛ بنابراین اگر به‌درستی پیکربندی نشود، ممکن است اطلاعات حساس در معرض دسترسی غیرمجاز قرار بگیرند یا عملیات ناخواسته روی سایت انجام شود. امنیت API باید از زمان طراحی و پیاده‌سازی در نظر گرفته شود.

۱. برای اطلاعات خصوصی احراز هویت و مجوز دسترسی تعریف کنید

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

۲. از HTTPS استفاده کنید

ارتباط میان نرم‌افزار و API باید از طریق HTTPS انجام شود تا اطلاعات در مسیر انتقال رمزگذاری شوند. این موضوع به‌ویژه هنگام ارسال اطلاعات ورود، توکن‌ها و داده‌های حساس اهمیت زیادی دارد.

۳. کلیدها و رمزهای دسترسی را در کد عمومی قرار ندهید

Application Password، Consumer Secret و سایر اطلاعات احراز هویت نباید در کد JavaScript سمت مرورگر یا فایل‌هایی که عموم کاربران به آن‌ها دسترسی دارند قرار بگیرند. این اطلاعات را در سمت سرور و در متغیرهای محیطی یا محل امن نگهداری کنید.

۴. دسترسی‌ها را به حداقل سطح لازم محدود کنید

اگر یک نرم‌افزار فقط باید اطلاعات محصولات را بخواند، نیازی نیست کلید دسترسی با مجوز ویرایش یا حذف اطلاعات در اختیار آن قرار دهید. اصل حداقل دسترسی باعث می‌شود در صورت افشای اطلاعات ورود، دامنه آسیب احتمالی محدودتر باشد.

۵. ورودی‌ها را اعتبارسنجی و پاک‌سازی کنید

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

۶. درخواست‌ها و خطاها را ثبت و کنترل کنید

برای APIهایی که در فرایندهای مهم کسب‌وکار استفاده می‌شوند، بهتر است گزارش مناسبی از خطاها و عملیات مهم داشته باشید. همچنین محدودیت نرخ درخواست (Rate Limiting) در سرویس‌های حساس می‌تواند به کنترل سوءاستفاده و فشار بیش از حد بر سرور کمک کند.

نکته مهم این است که بستن کامل REST API همیشه راهکار مناسبی نیست. ممکن است ویرایشگر بلوکی، افزونه‌ها یا اتصال‌های ضروری سایت به آن وابسته باشند. بهتر است به‌جای مسدود کردن کلی API، مسیرهای حساس و سطح دسترسی آن‌ها به‌صورت هدفمند مدیریت شوند.

پیشنهاد مطالعه : خطای 500 Internal Server Error در وردپرس چیست؟

خطاهای رایج REST API وردپرس و روش رفع آن‌ها

هنگام استفاده از REST API ممکن است با خطاهایی روبه‌رو شوید که مانع دریافت اطلاعات یا انجام عملیات می‌شوند. شناخت کدهای پاسخ HTTP و پیام خطا به شما کمک می‌کند علت مشکل را سریع‌تر پیدا کنید.

خطا یا کد پاسخمعنی احتمالیراهکار بررسی
401 Unauthorizedاحراز هویت انجام نشده یا اطلاعات ورود معتبر نیستنام کاربری، Application Password و روش احراز هویت را بررسی کنید.
403 Forbiddenکاربر احراز هویت شده اما مجوز لازم را ندارد یا دسترسی مسدود شده استقابلیت‌های کاربر، permission_callback و قوانین امنیتی را بررسی کنید.
404 Not Foundمسیر یا منبع موردنظر پیدا نشده استآدرس Endpoint، شناسه منبع و پیوندهای یکتا را بررسی کنید.
400 Bad Requestدرخواست یا پارامترهای ارسالی معتبر نیستندساختار JSON، نوع داده و پارامترها را بررسی کنید.
500 Internal Server Errorخطای داخلی سرور یا کد PHPگزارش خطای PHP، افزونه‌ها، قالب و کدهای اختصاصی را بررسی کنید.
rest_no_routeمسیر یا متد درخواست‌شده ثبت نشده یا با درخواست مطابقت نداردRoute، متد HTTP و ثبت Endpoint را کنترل کنید.
rest_cannot_createامکان ایجاد منبع با درخواست فعلی وجود نداردمجوز کاربر، پارامترهای ارسالی و تنظیمات Endpoint را بررسی کنید.

خطای REST API در پیشخوان وردپرس

گاهی هنگام ویرایش نوشته یا بررسی سلامت سایت، وردپرس پیامی درباره مشکل در REST API نمایش می‌دهد. این خطا ممکن است باعث اختلال در ذخیره‌سازی محتوا، بارگذاری برخی قابلیت‌های ویرایشگر یا عملکرد افزونه‌ها شود.

برای بررسی این مشکل، مراحل زیر را انجام دهید:

  • از بخش Tools و سپس Site Health، گزارش وضعیت سایت را بررسی کنید.
  • آدرس پایه API و مسیر دریافت نوشته‌ها را در مرورگر آزمایش کنید.
  • تنظیمات پیوندهای یکتا را بررسی و در صورت نیاز یک‌بار ذخیره کنید.
  • افزونه‌های امنیتی و فایروال را از نظر محدود کردن درخواست‌های API بررسی کنید.
  • گزارش خطاهای PHP و سرور را بررسی کنید.
  • در صورت نیاز، افزونه‌ها را در محیط آزمایشی به‌صورت مرحله‌ای غیرفعال کنید تا عامل تداخل مشخص شود.

اگر سایت پشت CDN یا فایروال قرار دارد، ممکن است درخواست‌های API به‌اشتباه مسدود شوند. در این شرایط، قوانین امنیتی و گزارش درخواست‌های مسدودشده را بررسی کنید. غیرفعال کردن کامل فایروال یا افزونه امنیتی در سایت اصلی، بدون بررسی و کنترل ریسک، توصیه نمی‌شود.

آیا REST API وردپرس روی سئو سایت تأثیر دارد؟

REST API به‌خودی‌خود یک عامل مستقیم برای افزایش رتبه سایت در گوگل نیست. فعال بودن API یا استفاده از آن برای دریافت محتوا، به‌تنهایی باعث بهبود جایگاه صفحات در نتایج جست‌وجو نمی‌شود. با این حال، نحوه استفاده از REST API می‌تواند به‌صورت غیرمستقیم بر ساختار فنی و تجربه کاربری سایت اثر بگذارد.

برای مثال، اگر از REST API برای ساخت یک وب‌سایت Headless استفاده کنید، باید مطمئن شوید محتوای اصلی برای موتورهای جست‌وجو قابل دسترسی و رندر شدن است. در صورت پیاده‌سازی نامناسب فرانت‌اند، ممکن است عنوان‌ها، توضیحات، لینک‌های داخلی یا محتوای اصلی صفحه به‌درستی در اختیار موتورهای جست‌وجو قرار نگیرند.

از سوی دیگر، استفاده اصولی از API می‌تواند امکان ارائه تجربه کاربری بهتر، نمایش سریع‌تر اطلاعات در بخش‌های خاص و اتصال یکپارچه سامانه‌ها را فراهم کند. این موارد در صورت اجرای فنی مناسب می‌توانند به کیفیت کلی محصول دیجیتال کمک کنند؛ اما جایگزین اصول سئو، محتوای مفید و معماری صحیح سایت نیستند.

چه زمانی به REST API نیاز داریم و چه زمانی استفاده از آن ضروری نیست؟

وجود REST API در وردپرس به این معنا نیست که همه سایت‌ها باید برای مدیریت محتوای خود از آن استفاده کنند. اگر یک سایت شرکتی یا وبلاگ معمولی دارید و امکانات قالب و افزونه‌های استاندارد نیازهای شما را پوشش می‌دهند، احتمالاً نیازی به توسعه اتصال اختصاصی API نخواهید داشت.

اما در پروژه‌هایی که قرار است وردپرس با نرم‌افزارهای دیگر ارتباط برقرار کند، اپلیکیشن اختصاصی داشته باشید، محتوای سایت در چند بستر نمایش داده شود یا فرایندهای سازمانی خودکار شوند، REST API می‌تواند راهکار مناسبی باشد.

نوع پروژهنیاز به REST API اختصاصیتوضیح
وبلاگ یا سایت شرکتی سادهمعمولاً ضروری نیستامکانات معمول وردپرس اغلب کافی هستند.
اپلیکیشن متصل به وردپرسبسیار کاربردیبرای دریافت و مدیریت داده‌ها از اپلیکیشن استفاده می‌شود.
فروشگاه ووکامرسی متصل به انبارکاربردیبرای همگام‌سازی محصولات، موجودی و سفارش‌ها.
وب‌سایت Headlessبخش اصلی معماریفرانت‌اند مستقل از طریق API با وردپرس ارتباط دارد.
سامانه سازمانی متصل به سایتبسیار کاربردیبرای انتقال اطلاعات و خودکارسازی فرایندها.

جمع‌بندی؛ REST API وردپرس چه ارزشی برای کسب‌وکارها دارد؟

REST API یکی از قابلیت‌های مهم وردپرس برای ارتباط با نرم‌افزارها و سامانه‌های دیگر است. این رابط امکان دریافت، ایجاد و به‌روزرسانی اطلاعات را از طریق درخواست‌های استاندارد HTTP فراهم می‌کند و داده‌ها را معمولاً در قالب JSON در اختیار برنامه‌ها قرار می‌دهد.

از اتصال سایت به اپلیکیشن موبایل و نرم‌افزارهای سازمانی گرفته تا ساخت وب‌سایت Headless، مدیریت خودکار محتوا و یکپارچه‌سازی فروشگاه ووکامرسی، REST API می‌تواند نقش مهمی در توسعه امکانات یک کسب‌وکار آنلاین داشته باشد.

با این حال، استفاده از API به طراحی درست مسیرها، مدیریت سطح دسترسی، احراز هویت امن، اعتبارسنجی داده‌ها و کنترل خطا نیاز دارد. پیاده‌سازی نادرست آن ممکن است باعث افشای اطلاعات یا اختلال در عملکرد سایت شود.

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

سؤالات متداول درباره REST API وردپرس

آیا REST API در وردپرس به‌صورت پیش‌فرض فعال است؟

بله. REST API بخشی از هسته وردپرس است و در نصب‌های استاندارد نیازی به نصب افزونه جداگانه ندارد. البته ممکن است افزونه‌های امنیتی، تنظیمات سرور یا قوانین فایروال دسترسی به بعضی مسیرها را محدود کرده باشند.

چگونه بفهمیم REST API سایت وردپرسی فعال است؟

آدرس https://example.com/wp-json/ را با دامنه سایت خود جایگزین کنید و در مرورگر باز کنید. اگر اطلاعات ساختاریافته API نمایش داده شود، مسیر پایه در دسترس است. برای آزمایش بیشتر می‌توانید مسیر /wp-json/wp/v2/posts را نیز بررسی کنید.

آیا برای استفاده از REST API باید برنامه‌نویسی بلد باشیم؟

برای مشاهده برخی اطلاعات عمومی، می‌توانید آدرس Endpoint را مستقیماً در مرورگر باز کنید. اما برای ساخت اتصال اختصاصی، ایجاد نوشته، مدیریت اطلاعات یا ارتباط با نرم‌افزارهای دیگر معمولاً به آشنایی با HTTP، JSON و یک زبان برنامه‌نویسی نیاز دارید.

آیا REST API وردپرس امنیت سایت را کاهش می‌دهد؟

وجود REST API به‌خودی‌خود به معنی ناامن بودن سایت نیست. اطلاعات عمومی سایت معمولاً بدون احراز هویت قابل دریافت هستند، اما عملیات حساس و اطلاعات خصوصی به مجوز مناسب نیاز دارند. اگر احراز هویت، سطح دسترسی و اعتبارسنجی ورودی‌ها به‌درستی پیاده‌سازی شوند، می‌توان از API به شکل امن استفاده کرد.

تفاوت REST API و GraphQL چیست؟

REST معمولاً برای منابع مختلف مسیرهای مشخصی دارد و کلاینت با درخواست به هر مسیر داده‌های موردنیاز را دریافت می‌کند. GraphQL از یک زبان پرس‌وجو استفاده می‌کند که در آن کلاینت می‌تواند مشخص کند چه فیلدهایی را از منابع مختلف نیاز دارد. هر دو روش کاربردهای خاص خود را دارند و انتخاب میان آن‌ها به معماری و نیاز پروژه بستگی دارد.

آیا می‌توان با REST API نوشته جدید در وردپرس منتشر کرد؟

بله. با ارسال درخواست POST به مسیر /wp-json/wp/v2/posts و ارائه اطلاعاتی مانند عنوان، محتوا و وضعیت انتشار می‌توان نوشته جدید ایجاد کرد. برای این کار باید احراز هویت انجام شود و حساب کاربری مجوز لازم برای ایجاد یا انتشار نوشته را داشته باشد.

آیا REST API برای فروشگاه ووکامرسی هم کاربرد دارد؟

بله. WooCommerce REST API امکان دریافت و مدیریت اطلاعاتی مانند محصولات، سفارش‌ها و مشتریان را فراهم می‌کند. این قابلیت برای اتصال فروشگاه به نرم‌افزارهای حسابداری، انبارداری و سامانه‌های مدیریت سفارش کاربرد دارد.

آیا غیرفعال کردن REST API برای افزایش امنیت وردپرس لازم است؟

خیر. غیرفعال کردن کامل REST API ممکن است عملکرد ویرایشگر بلوکی و برخی افزونه‌ها و اتصال‌های سایت را مختل کند. بهتر است به‌جای مسدود کردن کلی آن، دسترسی به مسیرهای حساس را بر اساس نیاز و سطح مجوز کاربران کنترل کنید.

منابع و مستندات رسمی برای مطالعه بیشتر

دیدگاه‌ خود را بنویسید

نشانی ایمیل شما منتشر نخواهد شد. بخش‌های موردنیاز علامت‌گذاری شده‌اند *

پیمایش به بالا