API заавар

Нэвтрэлт

Хүсэлт бүрт API түлхүүрээ Authorization толгойгоор дамжуулна.

API түлхүүр нь ws_ гэж эхэлсэн 51 тэмдэгттэй мөр. Түлхүүр бүр нэг төсөлд харьяалагдах бөгөөд тухайн төслийн кредитээр илгээнэ.

curl https://api.wesend.mn/v1/balance \
  -H "Authorization: Bearer $WESEND_API_KEY"

Түлхүүрийн удирдлага

  • Нэг төсөл 10 хүртэл идэвхтэй түлхүүртэй байна. Систем, орчин бүртээ тусдаа түлхүүр үүсгээрэй.
  • Түлхүүрийг үүсгэх үед л бүтнээр нь харуулна. Дараа нь зөвхөн эхний ба сүүлийн тэмдэгтүүд харагдана.
  • Хүчингүй болгосон түлхүүр тэр даруй ажиллахаа болино. Буцаах боломжгүй.
  • Гишүүнийг төслөөс хасахад түүний үүсгэсэн түлхүүрүүд мөн хүчингүй болно.

Түлхүүрийг зөвхөн серверээсээ ашигла. Браузер, гар утасны апп доторх кодонд бүү оруул: тэндээс хэн ч уншиж, таны кредитээр илгээж чадна.

Алдаа

Түлхүүр байхгүй, буруу эсвэл хүчингүй бол 401 invalid_api_key буцна. Нэг хаягаас буруу түлхүүрээр хэт олон удаа оролдвол 429 rate_limited буцаж, Retry-After толгойд хүлээх секундийг заана.

Хариу401 Unauthorized
{
  "error": {
    "code": "invalid_api_key",
    "message": "The API key is missing, unknown or revoked."
  }
}