API гарын авлага
Эрх ба түлхүүр
API-г хэн, хэрхэн ашиглах, түлхүүрээ хэрхэн хамгаалах вэ.
Эрх хүсэх#
GPU хүчин чадал хязгаартай тул API эрхийг хүн хянаж олгодог. Бүртгэлтэй хэрэглэгч бүр Тохиргоо → API хэсгээс юу бүтээж буйгаа бичиж хүсэлт гаргана. Ихэвчлэн ажлын хоёр өдрийн дотор имэйлээр хариулна.
Татгалзсан эсвэл эрх нь хаагдсан бол илүү дэлгэрэнгүй мэдээлэлтэйгээр дахин хүсэлт гаргаж болно. Эрхийг хаахад тухайн бүртгэлийн бүх түлхүүр шууд ажиллахаа больдог.
Хүсэлт гаргахад бэлэн үү?
Түлхүүр#
- Хэлбэр. Түлхүүр
vs_live_…хэлбэртэй. Бид зөвхөн хамгаалсан хэлбэрийг нь хадгалдаг тул бүтэн түлхүүр зөвхөн үүсгэх үед нэг удаа харагдана. - Тоо. Нэг бүртгэлд хамгийн ихдээ 10 идэвхтэй түлхүүр. Орчин бүрт (production, staging) тусдаа түлхүүр ашиглаарай.
- Хугацаа. 30, 90 эсвэл 365 хоногоор тохируулж болно. Хугацаа дууссан түлхүүр 401 буцаана.
- Хэний нэрээр. Түлхүүр таны нэрийн өмнөөс ажиллана: таны дуу хоолой, төсөл, түүхэд хандана, хэрэглээ таны өдрийн хязгаараас хасагдана.
Түлхүүрийг зөвхөн серверт хадгална
Эрхийн хүрээ#
Түлхүүр бүр зөвхөн сонгосон боломжуудад хандана. Шаардлагатай хүрээгүй түлхүүр 403 forbidden авна. /me, /usage, /jobs болон /realtime/tickets бүх түлхүүрт нээлттэй.
Түлхүүр солих#
- 1Шинэ түлхүүр үүсгэнэ.
- 2Серверээ шинэ түлхүүрээр шинэчилж байршуулна.
- 3Тохиргоо → API хэсгийн «Сүүлд ашигласан» баганаар хуучин түлхүүр ашиглагдахаа больсныг шалгаад хүчингүй болгоно.
Алдагдсан бол
Нөхцөл#
API ашиглалт Үйлчилгээний нөхцөл болон Зөвшөөрөгдөх хэрэглээний бодлого-д хамаарна. Ялангуяа хүний дууг зөвхөн эзний зөвшөөрөлтэйгөөр хуулна.
Түлхүүртэй болсон бол дараагийн алхам: хязгаар ба алдааг уншаад, анхны яриагаа үүсгээрэй.
Хэлний дүрэм
Тайлбар нь монгол хэлээр. Код, талбарын нэр, API-н алдааны мессеж англи хэлээр, яг API-д байгаагаар.