diff --git a/src/components/Common/icons.jsx b/src/components/Common/icons.jsx index 00883490..2c38b51a 100644 --- a/src/components/Common/icons.jsx +++ b/src/components/Common/icons.jsx @@ -73,6 +73,7 @@ import nuxtIcon from "@liara/platformicons/glass/png/nuxtjs.png"; import soketiIcon from "@liara/platformicons/glass/png/soketi.png"; import pythonIcon from "@liara/platformicons/glass/png/python.png"; import gatsbyIcon from "@liara/platformicons/glass/png/gatsby.png"; +import jsonIcon from "@liara/platformicons/glass/png/json.png"; // Databases @@ -107,6 +108,7 @@ const types = [ { logo: laravelIcon, alt: "laravel" }, { logo: netcoreIcon, alt: "netcore" }, { logo: angularIcon, alt: "angularjs" }, + { logo: jsonIcon, alt: "json" }, // One-click-apps { logo: n8nIcon, alt: "n8n" }, { logo: odooIcon, alt: "odoo" }, diff --git a/src/components/Sidebar/data.js b/src/components/Sidebar/data.js index 096d9647..0c7dc5ad 100644 --- a/src/components/Sidebar/data.js +++ b/src/components/Sidebar/data.js @@ -6569,11 +6569,11 @@ export default { icon: , link: "/references/liara-cli/about" }, - { - title: "خلاصه دستورات", - icon: , - link: "/references/liara-cli/about" - }, + // { + // title: "خلاصه دستورات", + // icon: , + // link: "/references/liara-cli/about" + // }, { hr: true }, @@ -6700,6 +6700,45 @@ export default { link: "/references/liara-cli/choose-default-account" }, ], + + 'liara-api': [ + { + badge: ( +
+ + ابزار Liara API +
+ ) + }, + { + title: "برگشت به خانه", + icon: , + link: "/" + }, + { + title: "Liara API چیست؟", + icon: , + link: "/references/liara-api/about" + }, + // { + // title: "خلاصه دستورات", + // icon: , + // link: "/references/liara-api/about" + // }, + { + hr: true + }, + { + title: "مستندات OpenAPI", + icon: , + link: "https://openapi.liara.ir/" + }, + { + title: "دریافت اطلاعات جامع کاربری", + icon: , + link: "/references/liara-api/get-info" + }, + ], }, diff --git a/src/pages/references/liara-api/about.mdx b/src/pages/references/liara-api/about.mdx new file mode 100644 index 00000000..47843fff --- /dev/null +++ b/src/pages/references/liara-api/about.mdx @@ -0,0 +1,90 @@ +import Layout from "@/components/Layout"; +import Button from "@/components/Common/button"; +import Section from "@/components/Common/section"; +import Alert from "@/components/Common/alert"; +import Tabs from "@/components/Common/tab"; +import Step from "@/components/Common/step"; +import Card from "@/components/Common/card"; +import Important from "@/components/Common/important"; +import Highlight from "react-highlight"; +import Link from "next/link"; +import PlatformIcon from "@/components/Common/icons"; + +import { + GoContainer, + GoDatabase, + GoRocket, + GoServer, + GoMail, + GoGlobe, + GoArrowLeft, +} from "react-icons/go"; + + +# Liara API +
+ +لیارا API مجموعه‌ای از توابع و پروتکل‌ها است که به کاربران اجازه می‌دهد تا از طریق درخواست‌های HTTP، منابع و سرویس‌های لیارا را مدیریت کنند. این API ها می‌توانند برای انجام وظایفی مانند ایجاد، حذف و مدیریت اپلیکیشن‌ها، دیتابیس‌ها و سایر منابع استفاده شوند. استفاده از لیارا API فرآیندهای مدیریت سرورها و اپلیکیشن‌ها را به صورت خودکار و ساده‌تر می‌کند. +
+ +هر کدام از محصولات لیارا، آدرس API مخصوص خود را دارند. برای مثال، آدرس API برای دسترسی به برنامه‌ها: + +
+
+ +{`https://api.iran.liara.ir/`} + +
+
+ + +
+کلید دسترسی به API یا API Key، یک رشته‌ی منحصربه‌فرد از کاراکترها است که به عنوان شناسه‌ی کاربر برای استفاده از API استفاده می‌شود. این کلید به منظور احراز هویت و تعیین سطح دسترسی کاربر به سرویس‌های مختلف API به کار می‌رود. با استفاده از کلید دسترسی، سرویس‌دهنده می‌تواند درخواست‌ها را به کاربر مشخصی نسبت دهد، مصرف منابع را مدیریت کند و امنیت را افزایش دهد. به‌عبارت‌دیگر، کلید دسترسی مانند یک گذرواژه عمل می‌کند که باید به‌صورت محرمانه نگهداری شود. + +
+برای مشاهده کلید دسترسی به API حساب خود در لیارا، کافیست تا وارد منوی **API** شده و بر روی گزینه **ساخت کلید جدید**، کلیک کنید تا کلید API به شما، نمایش داده شود: + +
+get liara api +
+نحوه‌ی استفاده از این Token برای کار با APIها به این صورت است که آن را به‌شکل زیر در HEADERها به سمت endpoint مربوطه ارسال می‌کنید: + +
+
+ +{`Authorization: Bearer $TOKEN`} + +
+
+ + + +
+ + +
+ {[ + { + title: "مستندات OpenAPI", + link: "https://openapi.liara.ir/" + }, + { + title: "دریافت اطلاعات جامع کاربری", + link: "/references/liara-api/get-info" + },].map(item => + + +
+

+ {item.title} +

+
+ +
+ + )} +
+ +
+ + \ No newline at end of file diff --git a/src/pages/references/liara-api/get-info.mdx b/src/pages/references/liara-api/get-info.mdx new file mode 100644 index 00000000..efc0b863 --- /dev/null +++ b/src/pages/references/liara-api/get-info.mdx @@ -0,0 +1,37 @@ +import Layout from "@/components/Layout"; +import Button from "@/components/Common/button"; +import Section from "@/components/Common/section"; +import Alert from "@/components/Common/alert"; +import Tabs from "@/components/Common/tab"; +import Step from "@/components/Common/step"; +import Card from "@/components/Common/card"; +import Important from "@/components/Common/important"; +import Highlight from "react-highlight"; +import Link from "next/link"; +import PlatformIcon from "@/components/Common/icons"; + +import { + GoContainer, + GoDatabase, + GoRocket, + GoServer, + GoMail, + GoGlobe, + GoArrowLeft, +} from "react-icons/go"; + + +# دریافت اطلاعات جامع کاربری +
+ +در endpoint زیر شما می‌توانید به اطلاعات کاملی از حساب کاربری، پلن‌های قابل انتخاب به‌همراه قیمت، مشخصات هر پلن و نسخه‌های دیتابیس‌ها دسترسی داشته باشید. بنابراین از اطلاعاتی که از این endpoint دریافت می‌کنید می‌توانید در endpointهای دیگر استفاده کنید: + +
+
+ +{`GET/v1/me`} + +
+
+ + \ No newline at end of file diff --git a/src/pages/references/liara-cli/about.mdx b/src/pages/references/liara-cli/about.mdx index 0d832b66..691cdd2a 100644 --- a/src/pages/references/liara-cli/about.mdx +++ b/src/pages/references/liara-cli/about.mdx @@ -28,22 +28,98 @@ import {
-
+
{[ - { - text: 'آشنایی با جزئیات دیتابیس', - link: './details/about', - }, - { - text: 'نحوه انتقال دیتابیس', - link: './move', - }, + { + title: "نصب و به‌روزرسانی", + link: "/references/liara-cli/install" + }, + { + title: "ورود به حساب کاربری", + link: "/references/liara-cli/login" + }, + { + title: "مدیریت دیسک‌ها", + link: "/references/liara-cli/manage-disks" + }, + { + title: "مشاهده پلن‌های سرویس پلتفرم", + link: "/references/liara-cli/see-platform-plans" + }, + { + title: "تکمیل خودکار دستورات", + link: "/references/liara-cli/autocomplete" + }, + { + title: "استقرار برنامه", + link: "/references/liara-cli/deploy-app" + }, + { + title: "ایجاد یک برنامه", + link: "/references/liara-cli/create-app" + }, + { + title: "حذف یک برنامه", + link: "/references/liara-cli/delete-app" + }, + { + title: "لیست‌کردن برنامه‌ها", + link: "/references/liara-cli/list-apps" + }, + { + title: "مشاهده لاگ‌های برنامه", + link: "/references/liara-cli/see-app-logs" + }, + { + title: "ری‌استارت برنامه", + link: "/references/liara-cli/restart-app" + }, + { + title: "اتصال به خط فرمان برنامه", + link: "/references/liara-cli/connect-to-app-shell" + }, + { + title: "روشن‌کردن برنامه", + link: "/references/liara-cli/start-app" + }, + { + title: "خاموش‌کردن برنامه", + link: "/references/liara-cli/stop-app" + }, + { + title: " لیست متغیرهای ثبت شده برنامه", + link: "/references/liara-cli/list-envs" + }, + { + title: "ثبت یا ویرایش متغیرهای محیطی", + link: "/references/liara-cli/add-or-edit-envs" + }, + { + title: "حذف متغیرهای محیطی یک برنامه", + link: "/references/liara-cli/remove-env" + }, + { + title: "اضافه کردن حساب کاربری جدید", + link: "/references/liara-cli/add-account" + }, + { + title: "لیست حساب‌های کاربری ", + link: "/references/liara-cli/list-accounts" + }, + { + title: "حذف یکی از حساب‌های کاربری", + link: "/references/liara-cli/remove-account" + }, + { + title: "انتخاب حساب پیش‌فرض", + link: "/references/liara-cli/choose-default-account" + }, ].map(item =>

- {item.text} + نحوه {item.title}