API заавар

Нэвтрэлт

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

API түлхүүр нь ws_ гэж эхэлсэн 51 тэмдэгттэй мөр. Түлхүүр бүр нэг төсөлд харьяалагдах бөгөөд тухайн төслийн кредитээр илгээнэ. ws_test_ гэж эхэлсэн sandbox түлхүүр юу ч илгээхгүй, кредит зарцуулахгүй: «Sandbox» хуудсыг үзнэ үү.

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

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

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

IP хязгаар

Түлхүүр бүрт зөвшөөрөх IP хаяг, CIDR мужийг (IPv4, IPv6) 20 хүртэл оруулж болно. Жагсаалт хоосон бол түлхүүрийг дурын хаягаас ашиглана. Хаяг нэмсэн даруйд жагсаалтад ороогүй хаягаас ирсэн хүсэлт 403 ip_not_allowed алдаагаар татгалзагдана. Ингэснээр түлхүүр алдагдсан ч таны серверээс өөр газраас ашиглах боломжгүй.

Хариу403 Forbidden
{
  "error": {
    "code": "ip_not_allowed",
    "message": "This API key does not accept requests from 198.51.100.7."
  }
}

Самбарын API түлхүүр хэсэгт түлхүүрийн «IP хязгаар» дээр дарж тохируулна. Түлхүүрийг сүүлд ашигласан хаяг тэнд харагдах тул нэг товшилтоор нэмж болно.

Үйлдлийн түүх

Түлхүүр үүсгэсэн, хүчингүй болгосон, IP хязгаар өөрчилсөн үйлдэл бүр хэн, хэзээ хийснийх нь хамт API түлхүүр хуудсанд бүртгэгдэнэ. IP хязгаарт ороогүй хаягаас ирсэн хүсэлт мөн бүртгэгдэнэ (нэг хаяг, нэг түлхүүрт цагт нэг удаа).

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

Алдаа

Түлхүүр байхгүй, буруу эсвэл хүчингүй бол 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."
  }
}