مستندات وان سرویس

به صفحه مستندات وان سرویس خوش آمدید!

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

کلید های دسترسی

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

رمزینه حساب شما باید در نزد شما خصوصی باقی بماند، رمزینه حساب شما از بخش مدیریت رمزینه یا توکن در پنل کاربری شما قابل تغییر یا بازیابی است.

نحوه استفاده

در تمامی درخواست های ارسالی، رمزینه فعال شما باید از طریق هدر (header) one-api-token تعیین و ارسال شود، درخواست های بدون رمزینه معتبر پردازش نمیشوند!

تمامی وبسرویس ها در متد های استاندارد HTTP نظیر GET و POST طبق مستندات ارائه شده قابل استفاده هستند. توجه داشته باشید که پارامتر های درخواستی در متد GET اغلب بصورت query string و در متد POST از طریق بدنه درخواست (request body) دریافت میشوند.

راهنمای مستندات

تمامی وبسرویس ها در متد های استاندارد HTTP نظیر GET و POST طبق مستندات ارائه شده قابل استفاده هستند. توجه داشته باشید که پارامتر های درخواستی در متد GET اغلب بصورت query string و در متد POST از طریق بدنه درخواست (request body) دریافت میشوند.

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

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

در راهنمای هر وبسرویس، متود (method)، مسیر (path) , پارامتر ها (parameters) های اختیاری و اجباری (*) مشخص شدند. پارامتر ها میتوانند از طریق کوئری (query)، مسیر (path) وبسرویس و یا در بدنه درخواست (body request) تنظیم شوند، در کنار هر کدام از پارامتر ها محل قرار گیری (query یا path) و نوع پارامتر (string - integer یا ...) مشخص شده است، توجه داشته باشید که پارامتر هایی که از در بدنه درخواست تنظیم میشوند حتما باید در قالب json باشند.

query example:
/api/?parameter=value
path example:
/api/parameter-value/
body request example:
{"parameter"=>"value"}

شما میتوانید از طریق قسمت Try it out هر وبسرویس با تغییر دلخواه پارامتر ها و تولید درخواست و اجرای آن (execute)، وبسرویس موردنظر را تست و بررسی نمایید، خروجی وبسرویس به محض پردازش در باکس زیرین آن نمایش داده خواهد شد. همچنین کامند curl معادل درخواست تولید شده برای شما تولید میشود که این کامند را میتوانید از طریق ابزار هایی مانند curlconverter به سورس کد های معادل در زبان های برنامه نویسی موردنظرتان تبدیل نمایید.

در نگارش این مستندات از استاندارد openapi استفاده شده است. درنتیجه علاوه بر این صفحه، شما میتوانید با جایگذاری لینک مستندات openapi زیر در ابزار هایی نظیر Postman، مستندات وبسرویس را درون ریزی کنید.

https://docs.one-api.ir/openapi/twitter

مستندات وبسرویس

کد های وضعیت

درخواست های موفق با کد وضعیت (status) 200 در پاسخ درخواست علامت گذاری خواهند شد، در صورتی که درخواست شما موفقیت آمیز نبوده باشد یا به دلیلی در مرحله پردازش به خطایی برخورد کرده باشد، علاوه بر اعلام یکی از وضعیت های زیر، علت خطا بصورت خلاصه در پارامتر message به شما اعلام خواهد شد.