این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

Blogger API: شروع به کار

این سند نحوه شروع استفاده از Blogger API را توضیح می دهد.

قبل از اینکه تو شروع کنی

یک حساب Google دریافت کنید

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

با بلاگر آشنا شوید

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

درباره مجوز دادن به درخواست ها و شناسایی برنامه خود بیاموزید

هنگامی که برنامه شما داده های خصوصی را درخواست می کند، درخواست باید توسط یک کاربر احراز هویت که به آن داده ها دسترسی دارد مجاز باشد.

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

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

پس‌زمینه API Blogger

مفاهیم بلاگر

بلاگر بر اساس پنج مفهوم اساسی ساخته شده است:

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

مدل داده Blogger API

یک منبع یک موجودیت داده منفرد با یک شناسه منحصر به فرد است. Blogger JSON API بر روی پنج نوع منبع کار می کند:

منبع وبلاگ ها : نشان دهنده یک وبلاگ است.
منبع پست ها : یک پست را نشان می دهد. هر منبع پست فرزند منبع وبلاگ است.
منبع نظرات : نمایانگر یک نظر در مورد یک پست خاص است. هر منبع نظرات فرزند منبع پست است.
منابع صفحات : یک صفحه ثابت را نشان می دهد. هر منبع صفحه فرزند منبع وبلاگ است.
منبع کاربران : نشان دهنده یک کاربر غیر ناشناس است. این برای شناسایی نویسنده یک صفحه، پست یا نظر استفاده می شود.

منبع وبلاگ دارای دو نوع منبع فرزند، صفحات و پست است. یک منبع پست ممکن است دارای منبع نظرات باشد. — مروری بر روابط بین منابع

مدل داده Blogger API بر اساس گروه‌هایی از منابع است که مجموعه‌ها نامیده می‌شوند:

مجموعه وبلاگ ها: آ مجموعه وبلاگ ها شامل تمام وبلاگ هایی است که کاربر حق دسترسی به آنها را دارد. می توانید وبلاگ ها را بر اساس کاربر فهرست کنید، یا یک وبلاگ را با شناسه بازیابی کنید.
مجموعه پست ها: مجموعه پست ها شامل تمام منابع پست ها در یک منبع وبلاگ خاص است.
مجموعه نظرات: مجموعه نظرات شامل تمام منابع نظرات در یک منبع پست خاص است.
مجموعه صفحات: مجموعه صفحات شامل تمام منابع صفحات در یک منبع وبلاگ خاص است.
مجموعه کاربران: مجموعه کاربران از تمام منابع کاربران در بلاگر تشکیل شده است و بنابراین نمی توان آنها را فهرست کرد. یک کاربر می تواند منبع کاربران خود (اما هیچ کس دیگری) را با شناسه یا با استفاده از self شناسه بازیابی کند.

عملیات API Blogger

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

عمل	شرح	REST نگاشت HTTP
فهرست	تمام منابع موجود در یک مجموعه را فهرست می کند.	`GET` URI مجموعه.
گرفتن	یک منبع خاص به دست می آورد.	`GET` URI منبع.
getByUrl	منبعی را دریافت می کند و آن را با URL جستجو می کند.	با URL ارسال شده به عنوان پارامتر `GET` .
getByPath	یک منبع را با جستجوی مسیر آن به دست می آورد.	`GET` با Path به عنوان پارامتر دریافت کنید.
listByUser	فهرست منابع متعلق به یک کاربر.	در مجموعه متعلق به کاربر `GET` .
جستجو کردن	جستجوی منابع، بر اساس پارامتر پرس و جو.	در یک URL جستجو، با درخواست ارسال شده به عنوان یک پارامتر، `GET` .
درج کنید	یک منبع در یک مجموعه ایجاد کنید.	در یک URI مجموعه `POST` .
حذف	یک منبع را حذف می کند.	`DELETE` در یک URI منبع.
پچ	با استفاده از Patch semantics یک منبع را به روز کنید.	`PATCH` روی URI منبع.
به روز رسانی	یک منبع را به روز کنید	یک URI منبع را `PUT` .

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

نوع منبع	روش های پشتیبانی شده
	فهرست	گرفتن	getByUrl	getByPath	listByUser	جستجو کردن	درج کنید	حذف	پچ	به روز رسانی
وبلاگ ها	نه	آره	آره	نه	آره	نه	نه	نه	نه	نه
نوشته ها	آره	آره	نه	آره	نه	آره	آره	آره	آره	آره
نظرات	آره	آره	نه	نه	نه	نه	نه	نه	نه	نه
صفحات	آره	آره	نه	نه	نه	نه	نه	نه	نه	نه
کاربران	نه	آره	نه	نه	نه	نه	نه	نه	نه	نه

سبک های فراخوانی

چندین راه برای فراخوانی API وجود دارد:

استفاده از REST به طور مستقیم یا از جاوا اسکریپت (بدون نیاز به کد سمت سرور)
استفاده از کتابخانه های مشتری

باقی مانده

REST سبکی از معماری نرم افزار است که یک رویکرد راحت و سازگار برای درخواست و اصلاح داده ها ارائه می دهد.

اصطلاح REST مخفف " انتقال دولت نمایندگی " است. در زمینه Google API ها، به استفاده از افعال HTTP برای بازیابی و اصلاح نمایش داده های ذخیره شده توسط Google اشاره دارد.

در یک سیستم RESTful، منابع در یک فروشگاه داده ذخیره می شوند. یک سرویس گیرنده درخواستی را ارسال می کند که سرور یک عمل خاص را انجام دهد (مانند ایجاد، بازیابی، به روز رسانی یا حذف یک منبع)، و سرور این عمل را انجام می دهد و پاسخی را می فرستد، اغلب به شکل یک نمایش از منبع مشخص شده.

در API های RESTful Google، مشتری با استفاده از یک فعل HTTP مانند POST ، GET ، PUT ، یا DELETE ، اقدامی را مشخص می کند. این یک منبع را توسط یک URI منحصر به فرد جهانی به شکل زیر مشخص می کند:

https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters

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

ممکن است تعاریف روش را در مستندات استانداردهای HTTP 1.1 مفید بیابید. آنها شامل مشخصات GET ، POST ، PUT و DELETE هستند.

REST در Blogger API

عملیات پشتیبانی شده Blogger به طور مستقیم به افعال HTTP REST، همانطور که در عملیات API Blogger توضیح داده شده است، نگاشت.

فرمت خاص URI های API Blogger عبارتند از:

https://www.googleapis.com/blogger/v3/users/userId
https://www.googleapis.com/blogger/v3/users/self
https://www.googleapis.com/blogger/v3/users/userId/blogs
https://www.googleapis.com/blogger/v3/users/self/blogs
https://www.googleapis.com/blogger/v3/blogs/blogId
https://www.googleapis.com/blogger/v3/blogs/byurl
https://www.googleapis.com/blogger/v3/blogs/blogId/posts
https://www.googleapis.com/blogger/v3/blogs/blogId/posts/bypath
https://www.googleapis.com/blogger/v3/blogs/blogId/posts/search
https://www.googleapis.com/blogger/v3/blogs/blogId/posts/postId
https://www.googleapis.com/blogger/v3/blogs/blogId/posts/postId/comments
https://www.googleapis.com/blogger/v3/blogs/blogId/posts/postId/comments/commentId
https://www.googleapis.com/blogger/v3/blogs/blogId/pages
https://www.googleapis.com/blogger/v3/blogs/blogId/pages/pageId

توضیح کامل URI های استفاده شده و نتایج هر عملیات پشتیبانی شده در API در سند مرجع API Blogger خلاصه شده است.

مثال ها

وبلاگ هایی را که کاربر احراز هویت شده حق دسترسی به آنها را دارد فهرست کنید:

GET https://www.googleapis.com/blogger/v3/users/self/blogs?key=YOUR-API-KEY

پست‌ها را در وبلاگ code.blogger.com ، که شناسه وبلاگ 3213900 دارد، دریافت کنید:

GET https://www.googleapis.com/blogger/v3/blogs/3213900?key=YOUR-API-KEY

REST از جاوا اسکریپت

می توانید API Blogger را از جاوا اسکریپت، با استفاده از پارامتر پرس و جوی callback و با ارائه یک تابع پاسخ به تماس فراخوانی کنید. هنگامی که مرورگر اسکریپت را بارگذاری می کند، تابع callback اجرا می شود و پاسخ به تابع callback ارائه می شود. این رویکرد به شما امکان می دهد برنامه های کاربردی غنی بنویسید که داده های بلاگر را بدون نیاز به کد سمت سرور نمایش می دهند.

مثال زیر پس از جایگزینی YOUR-API-KEY با کلید API خود، یک پست را از وبلاگ code.blogger.com بازیابی می کند.

<html>
  <head>
    <title>Blogger API Example</title>
  </head>
  <body>
    <div id="content"></div>
    <script>
      function handleResponse(response) {
        document.getElementById("content").innerHTML += "<h1>" + response.title + "</h1>" + response.content;
      }
    </script>
    <script
    src="https://www.googleapis.com/blogger/v3/blogs/3213900/posts/8398240586497962757?callback=handleResponse&key=YOUR-API-KEY"></script>
  </body>
</html>

فرمت داده

JSON

JSON (JavaScript Object Notation) یک قالب داده رایج و مستقل از زبان است که نمایش متنی ساده ای از ساختارهای داده دلخواه را ارائه می دهد. برای اطلاعات بیشتر، به json.org مراجعه کنید.