Баримт бичиг / API лавлах

API лавлах

REST API-ийн зарчим ба OpenAPI баримтаас автоматаар үүссэн бүх үйлдэл.

API нь HTTPS дээрх JSON. Үндсэн хаяг https://api.a-z.mn/v1.

Нэвтрэлт

Ажлын орчны API түлхүүрийг bearer токен болгон илгээ:

curl https://api.a-z.mn/v1/workspaces/WORKSPACE/links \
  -H "Authorization: Bearer az_YOUR_KEY"

Түлхүүрийг Тохиргоо, API түлхүүр хэсэгт үүсгэнэ. Түлхүүр эрх ба хамрах хүрээтэй, үйлдэл бүр шаардлагатай хүрээгээ жагсаасан байдаг. Нэвтрэлт байхгүй эсвэл буруу бол 401, хүрээ эсвэл эрх дутвал 403, таны харьяалдаггүй ажлын орчин 404 буцаана. Хөтөч талын хяналтын дуудлага оронд нь нийтийн түлхүүр ашиглана, Хөрвүүлэлтийн хяналт үз.

Ажлын орчин

Ихэнх зам /workspaces/{workspaceId}-ээр эхэлнэ, энд ажлын орчны id (ws_...) эсвэл slug орно.

Алдаа

2xx биш хариу бүр нэг error объекттой:

{
  "error": {
    "code": "not_found",
    "errorCode": "AZ-LNK-004",
    "message": "Холбоос олдсонгүй. Устгагдсан байж магадгүй.",
    "doc_url": "...",
    "requestId": "..."
  }
}

code тогтвортой тул салаалахад аюулгүй. message нь Accept-Language толгойгоор орчуулагдах тул задлан шинжилж болохгүй. Дэмжлэгт хандахдаа requestId-г дурд. Баталгаажуулалтын алдаа error.fields-д буруу талбаруудыг жагсааж болно.

Хуудаслалт

Том жагсаалт cursor ашиглана: startingAfter эсвэл endingBefore (бүртгэлийн id) ба 100 хүртэл хуудасны хэмжээ дамжуул. Хариу нь энгийн массив, Link толгой дараагийн хуудсыг өгнө. Шошго зэрэг энгийн жагсаалт page, pageSize ашиглана.

Хүсэлтийн хязгаар

Хязгаар нь ажлын орчин бүрээр, багцаас хамаарна: анхдагчаар Free минутад 60, Pro 600, Business 1,200, Enterprise 3,000. Шинжилгээний эндпойнтод секундийн хатуу хязгаар бий. Хариунд хязгаарын толгой ирэх бөгөөд хэтэрвэл 429 ба дахин оролдох хугацаа буцна. Лавлахын оронд олноор хийх эндпойнт, вебхүүк ашигла.

Үйлдлүүд

Доорх бүлгээс сонго. Хуудсанд зөвхөн API түлхүүрээр дуудаж болох үйлдлийг жагсаасан.