API токен

API токен нь Byl API-д хандах таны түлхүүр юм. Хүсэлт бүрд Authorization header-ээр дамжуулагдана.

Токен үүсгэх

1. Удирдлагын буланд нэвтэрнэ.
2. Төслөө сонгоод зүүн талын цэсний Тохиргоо → API токэн хуудсанд орно.
3. Токендоо санахад хялбар нэр өгөөд (жишээ нь production-server, staging) үүсгэнэ.

Токеноо нэг л удаа харуулна

Үүсгэсний дараа токен танд зөвхөн нэг удаа харагдана. Тэр даруй хуулж, өөрийн серверийн орчны хувьсагч (environment variable) эсвэл secret manager-т хадгална уу. Кодод шууд бичих, git-т commit хийхээс зайлсхийнэ.

Токен алдагдсан эсвэл шаардлагагүй болсон бол ижил хуудаснаас устгаж хүчингүй болгоод, шинэ токен үүсгэнэ. Хуучин токен устсан даруйдаа ажиллахаа болино.

Токены хүрээ

Токен нь таны хэрэглэгчийн эрхэд холбогддог, төслийн биш. Тиймээс:

• Та гишүүнээр байдаг багийн бүх төсөлд нэг токен ажиллана.
• Аль төсөл рүү хандахыг хүсэлтийн хаяг дахь төслийн ID шийднэ.
• Гишүүн биш төслийн хаяг дуудвал 403 буцна.

TIP

Орчин тус бүрд (production, staging, локал хөгжүүлэлт) тусдаа токен үүсгэвэл нэгийг хүчингүй болгоход бусад нь тасалдахгүй.

Токен ашиглан API дуудах

Токеноо Authorization: Bearer <токен> хэлбэрээр дамжуулна. Доорх жишээ шинээр нэхэмжлэх үүсгэж байна:

BYL_PROJECT_ID="таны төслийн ID"
BYL_TOKEN="таны API token"

curl -X POST https://byl.mn/api/v1/projects/$BYL_PROJECT_ID/invoices \
    -H "Authorization: Bearer $BYL_TOKEN" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -d '{ "amount": 1000, "description": "Test invoice" }'

Токеноор таныг таньж, тухайн төсөлд нэхэмжлэх үүсгэн дараах хариу буцаана:

{
  "data": {
    "id": 3,
    "status": "open",
    "amount": 1000,
    "description": "Test invoice",
    "number": "DEMO-0011",
    "project_id": 1,
    "due_date": "2026-06-25T05:27:42.000000Z",
    "created_at": "2026-06-24T05:27:42.000000Z",
    "updated_at": "2026-06-24T05:27:42.000000Z",
    "url": "https://byl.mn/h/invoice/3/XN3GbRBxTslkMCeDj10CJtqlHiPfcmZ8"
  }
}

Түгээмэл алдаа

Токен байхгүй, буруу бичсэн эсвэл устгагдсан бол 401 буцна:

{
  "message": "Unauthenticated."
}

Шалгах зүйлс:

• Bearer гэсэн угтвар болон түүний дараах зай байгаа эсэх.
• Токеныг хуулах үед хоосон зай, шинэ мөр орсон эсэх.
• Accept: application/json header-ийг зааж өгсөн эсэх — эс бөгөөс алдаа HTML хэлбэрээр ирж болно.

Токен зөв ч 403 ирвэл таны хэрэглэгч тухайн төслийн багийн гишүүн биш байна. Алдааны бүх кодын жагсаалтыг API тойм хуудаснаас уншина уу.