API لیارا

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

فهرست عناوین:

• کلید احراز هویت
• دریافت اطلاعات جامع کاربری
• مستندات OpenAPI

آدرس API

هر کدام از محصولات لیارا، آدرس API مخصوص خود را دارند. برای مثال، آدرس API برای دسترسی به برنامه‌ها:

https://api.iran.liara.ir/

کلید احراز هویت

شما با مراجعه به پنل کاربری و وارد شدن به بخش API امکان مشاهده و دریافت Token اختصاصی حساب خودتان را دارید. به‌کمک این Token می‌توانید از سازوکارهای CI/CD و تعامل با API لیارا استفاده کنید.
نحوه‌ی استفاده از این Token برای کار با APIها به این صورت است که آن را به‌شکل زیر در HEADERها به سمت endpoint مربوطه ارسال می‌کنید:

Authorization: Bearer $TOKEN

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

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

مستندات OpenAPI

مستندات API لیارا در آدرس زیر در دسترس است:
https://openapi.liara.ir

ما برای نوشتن این مستندات از OpenAPI Specification v3 استفاده کرده‌ایم که در GitHub در دسترس است. بنابراین، می‌توانید فایل‌های Yaml موجود در ریپازیتوری گیت‌هاب را در Postman وارد کنید تا مستقیما به تمام Endpointها دسترسی داشته باشید.