نسخه API 1.1

این مستندات نحوه ثبت، پیکربندی و توسعه برنامه خود را توضیح می دهد تا بتوانید با موفقیت از API های ما استفاده کنید

ایجاد اپلیکیشن

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

1. شما باید یک برنامه جدید ایجاد کنید ساختن برنامه جدید
2. هنگامی که برنامه خود را ایجاد کردید، برنامه خود را دریافت خواهید کرد app_id و app_secret

ورود با

ورود به سیستم با سیستم یک راه سریع و راحت برای افراد برای ایجاد حساب و ورود به برنامه شما است. سیستم Log in With ما دو سناریو، احراز هویت و درخواست مجوز برای دسترسی به داده‌های افراد را فعال می‌کند. شما می توانید از سیستم Login With به سادگی برای احراز هویت یا برای احراز هویت و دسترسی به داده ها استفاده کنید.

1. با شروع فرآیند ورود به سیستم OAuth، باید از پیوندی مانند این برای برنامه خود استفاده کنید:

   <a href="https://coffbook.com/api/oauth?app_id=YOUR_APP_ID">Log in With کاف بوک | بهترین شبکه اجتماعی برای دوستداران قهوه</a>

   کاربر به صفحه Log in With مانند این هدایت می شود

   
2. هنگامی که کاربر برنامه شما را پذیرفت، کاربر به URL تغییر مسیر برنامه شما هدایت می شود auth_key مثل این:

   https://mydomain.com/my_redirect_url.php?auth_key=AUTH_KEY

   این auth_key فقط برای یک بار استفاده معتبر است، بنابراین وقتی از آن استفاده کردید دیگر نمی توانید از آن استفاده کنید و کد جدید ایجاد کنید، باید کاربر را با پیوند دوباره به ورود به سیستم هدایت کنید..

توکن دسترسی

هنگامی که تأیید کاربر برنامه خود را دریافت کردید، با پنجره وارد شوید و با آن برگردید auth_key به این معنی که اکنون شما آماده بازیابی داده ها از API های ما هستید و برای شروع این فرآیند باید برنامه خود را مجوز دهید و access_token و می توانید مراحل ما را دنبال کنید تا نحوه دریافت آن را بیاموزید.

1. برای دریافت یک نشانه دسترسی، یک درخواست HTTP GET به نقطه پایانی زیر را مانند این ارسال کنید:

               <?php
               $app_id = "YOUR_APP_ID"; // your app id
               $app_secret = "YOUR_APP_SECRET"; // your app secret
               $auth_key = $_GET['auth_key']; // the returned auth key from previous step
   
               $get = file_get_contents("https://coffbook.com/api/authorize?app_id=$app_id&app_secret=$app_secret&auth_key=$auth_key");
   
               $json = json_decode($get, true);
               if(!empty($json['access_token'])) {
                   $access_token = $json['access_token']; // your access token
               }
               ?>                                                                                                
                               

   این access_token فقط برای یک ساعت اعتبار دارد، بنابراین هنگامی که نامعتبر شد، باید با هدایت مجدد کاربر به ورود به سیستم با پیوند، یک مورد جدید ایجاد کنید..

API ها

هنگامی که دریافت کنید access_token اکنون می توانید از طریق درخواست های HTTP GET که از پارامترهای زیر پشتیبانی می کند اطلاعات را از سیستم ما بازیابی کنید.

شما می توانید اطلاعات کاربر را مانند این بازیابی کنید

            if(!empty($json['access_token'])) {
                $access_token = $json['access_token']; // your access token
                $get = file_get_contents("https://coffbook.com/api/get_user_info?access_token=$access_token");
            }
                        

نتیجه خواهد شد:

            {
              "user_info": {
              "user_id": "",
              "user_name": "",
              "user_email": "",
              "user_firstname": "",
              "user_lastname": "",
              "user_gender": "",
              "user_birthdate": "",
              "user_picture": "",
              "user_cover": "",
              "user_registered": "",
              "user_verified": "",
              "user_relationship": "",
              "user_biography": "",
              "user_website": ""
              }
            }