-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
9b0b791
commit 0395604
Showing
5 changed files
with
259 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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"; | ||
|
||
<Layout> | ||
# Liara API | ||
<hr className="mb-2" /> | ||
|
||
لیارا API مجموعهای از توابع و پروتکلها است که به کاربران اجازه میدهد تا از طریق درخواستهای HTTP، منابع و سرویسهای لیارا را مدیریت کنند. این API ها میتوانند برای انجام وظایفی مانند ایجاد، حذف و مدیریت اپلیکیشنها، دیتابیسها و سایر منابع استفاده شوند. استفاده از لیارا API فرآیندهای مدیریت سرورها و اپلیکیشنها را به صورت خودکار و سادهتر میکند. | ||
<div className="h-2" /> | ||
|
||
هر کدام از محصولات لیارا، آدرس API مخصوص خود را دارند. برای مثال، آدرس API برای دسترسی به برنامهها: | ||
|
||
<div className="h-2" /> | ||
<div dir="ltr"> | ||
<Highlight className='bash'> | ||
{`https://api.iran.liara.ir/`} | ||
</Highlight> | ||
</div> | ||
<div className="h-2" /> | ||
|
||
|
||
<Section id="also-read" title="کلید دسترسی به API" /> | ||
کلید دسترسی به API یا API Key، یک رشتهی منحصربهفرد از کاراکترها است که به عنوان شناسهی کاربر برای استفاده از API استفاده میشود. این کلید به منظور احراز هویت و تعیین سطح دسترسی کاربر به سرویسهای مختلف API به کار میرود. با استفاده از کلید دسترسی، سرویسدهنده میتواند درخواستها را به کاربر مشخصی نسبت دهد، مصرف منابع را مدیریت کند و امنیت را افزایش دهد. بهعبارتدیگر، کلید دسترسی مانند یک گذرواژه عمل میکند که باید بهصورت محرمانه نگهداری شود. | ||
|
||
<div className="h-2" /> | ||
برای مشاهده کلید دسترسی به API حساب خود در لیارا، کافیست تا وارد منوی **API** شده و بر روی گزینه **ساخت کلید جدید**، کلیک کنید تا کلید API به شما، نمایش داده شود: | ||
|
||
<div className="h-4" /> | ||
<img src="https://files.liara.ir/liara/docs/get-liara-api.gif" alt="get liara api" /> | ||
<div className="h-4" /> | ||
نحوهی استفاده از این Token برای کار با APIها به این صورت است که آن را بهشکل زیر در HEADERها به سمت endpoint مربوطه ارسال میکنید: | ||
|
||
<div className="h-2" /> | ||
<div dir="ltr"> | ||
<Highlight className='bash'> | ||
{`Authorization: Bearer $TOKEN`} | ||
</Highlight> | ||
</div> | ||
<div className="h-2" /> | ||
|
||
|
||
|
||
<Section id="also-read" title="در ادامه، بخوانید:" /> | ||
|
||
|
||
<div className="grid grid-cols-2 gap-4"> | ||
{[ | ||
{ | ||
title: "مستندات OpenAPI", | ||
link: "https://openapi.liara.ir/" | ||
}, | ||
{ | ||
title: "دریافت اطلاعات جامع کاربری", | ||
link: "/references/liara-api/get-info" | ||
},].map(item => | ||
<Link href={item.link}> | ||
<Card className="flex cursor-pointer w-full items-center justify-between"> | ||
<div className="flex items-center gap-3"> | ||
<h4> | ||
{item.title} | ||
</h4> | ||
</div> | ||
<GoArrowLeft className="ml-1" /> | ||
</Card> | ||
</Link> | ||
)} | ||
</div> | ||
|
||
<br /> | ||
|
||
</Layout> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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"; | ||
|
||
<Layout> | ||
# دریافت اطلاعات جامع کاربری | ||
<hr className="mb-2" /> | ||
|
||
در endpoint زیر شما میتوانید به اطلاعات کاملی از حساب کاربری، پلنهای قابل انتخاب بههمراه قیمت، مشخصات هر پلن و نسخههای دیتابیسها دسترسی داشته باشید. بنابراین از اطلاعاتی که از این endpoint دریافت میکنید میتوانید در endpointهای دیگر استفاده کنید: | ||
|
||
<div className="h-2" /> | ||
<div dir="ltr"> | ||
<Highlight className='bash'> | ||
{`GET/v1/me`} | ||
</Highlight> | ||
</div> | ||
<div className="h-2" /> | ||
|
||
</Layout> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters