شروع سریع

پیش‌نیازها

ابتدا در کنسول ابربیت وارد شوید؛ یک پروژه بسازید یا پروژه‌ای را انتخاب کنید که عضو آن هستید.

برای این راهنما به ابزار curl و یک ترمینال سازگار با Bash نیاز دارید؛ درخواست آزمایشی فقط فهرست پروژه‌ها را می‌خواند و منبعی ایجاد نمی‌کند.

ساخت توکن

در پروژه، وارد بخش «امنیت» و زبانهٔ «توکن API» شوید؛ برای برنامهٔ خود یک توکن با نام مشخص بسازید.

توکن کامل فقط همان بار نمایش داده می‌شود؛ آن را در مدیر اسرار برنامه ذخیره کنید و در کد، مخزن گیت یا پیام پشتیبانی قرار ندهید.

تنظیم محیط

آدرس پایه و توکن را در محیط ترمینال قرار دهید؛ دستور زیر توکن را بدون نمایش روی صفحه می‌خواند و مقدار آن را داخل تاریخچهٔ دستورها نمی‌نویسد.

export ABRBIT_API='https://gateway.abrbit.com'
read -r -s -p 'API token: ' ABRBIT_TOKEN; printf '\n'
export ABRBIT_TOKEN

اولین درخواست

برای دریافت پروژه‌هایی که کاربر صاحب توکن عضو آن‌هاست، درخواست زیر را ارسال کنید؛ اسلش انتهای مسیر بخشی از نمونه است.

curl --fail-with-body --silent --show-error \
  "$ABRBIT_API/api/v1/projects/" \
  --header "Authorization: Bearer $ABRBIT_TOKEN"

پاسخ موفق با وضعیت 200 و پوشش objects و meta برمی‌گردد؛ نمونهٔ زیر پاسخ کوتاه‌شدهٔ توضیحی است و همهٔ فیلدها را نشان نمی‌دهد.

{
  "objects": [
    {"id": 123, "name": "پروژهٔ نمونه", "guid": "PROJECT_GUID", "role": "owner"}
  ],
  "meta": {"next": "", "count": 0}
}

مقدار guid پروژهٔ موردنظر را بردارید؛ عدد id جایگزین آن در مسیرهای پروژه نیست.

انتخاب پروژه

شناسهٔ عمومی پروژه در آدرس صفحهٔ پروژه در کنسول نیز وجود دارد؛ برای مثال در مسیر /projects/PROJECT_GUID/security، بخش میانی همان شناسه است.

export ABRBIT_PROJECT='PROJECT_GUID'
curl --fail-with-body --silent --show-error \
  "$ABRBIT_API/api/v1/projects/$ABRBIT_PROJECT/" \
  --header "Authorization: Bearer $ABRBIT_TOKEN"

پاسخ موفق این درخواست، خود شیء پروژه است و داخل objects قرار نمی‌گیرد؛ شکل پاسخ هر عملیات را در مرجع API بررسی کنید.

اگر پاسخ موفق نبود

برای خطای 401، کامل بودن توکن و پیشوند Bearer را بررسی کنید؛ برای خطای 403، عضویت کاربر در پروژه را بررسی کنید.

برای پاسخ 404، مسیر و شناسهٔ عمومی پروژه را بررسی کنید؛ جزئیات بیشتر در راهنمای خطاها آمده است.

پس از پایان آزمایش، می‌توانید متغیر توکن را از این ترمینال پاک کنید؛ این کار توکن را در سرور باطل نمی‌کند.

unset ABRBIT_TOKEN

برای ادامه، گردش کار ذخیره‌سازی را اجرا کنید یا مدیریت پروژه‌ها را بخوانید.