API түлхүүр
Тест болон бодит горимын API түлхүүр, түүнийг солих, IP хаягаар хязгаарлах арга.
API-ийн хүсэлт бүрд Authorization: Bearer <API түлхүүр> толгой шаардлагатай. API түлхүүрийг Хянах самбарын API түлхүүр хэсгээс үүсгэнэ.
| Угтвар | Горим | Оператор руу хандах |
|---|---|---|
sk_test_ | Тест | Үгүй |
sk_live_ | Бодит | Тийм |
API түлхүүрийн горим нь хариу, webhook, session, rule бүхний горимыг тодорхойлно. Цахим гэрээг бүртгүүлэх үедээ зөвшөөрнө.
curl https://api.2fa.mn/v1/webhook \
-H "Authorization: Bearer $TWOFA_KEY"Зөвхөн сервер дээр
Нууц API түлхүүрийг (sk_) хөтөч, мобайл апп эсвэл git-д хэзээ ч бүү оруулна уу. Орчны хувьсагчид (жишээ нь TWOFA_KEY) хадгална уу.
API түлхүүр солих
Хүчингүй болгосон API түлхүүр тэр даруй ажиллахаа болино. Тасалдалгүй солихын тулд:
Шинэ API түлхүүр үүсгэх
Хянах самбараас шинэ API түлхүүр үүсгэнэ.
Шинэ API түлхүүрийг байршуулах
Сервертээ шинэ API түлхүүрийг байршуулна.
Хуучныг хүчингүй болгох
Хуучин API түлхүүрийг хүчингүй болгоно.
API түлхүүр алдагдсан гэж сэжиглэвэл шууд хүчингүй болгоно уу.
IP хаягаар хязгаарлах
API түлхүүрийг зөвхөн тодорхой IP хаяг эсвэл CIDR-ээс (жишээ нь 203.0.113.10 эсвэл 203.0.113.0/24) ажилладаг болгож болно. Жагсаалтад ороогүй хаягаас ирсэн хүсэлт 401 unauthorized буцаана. Жагсаалт хоосон бол аль ч хаягаас ажиллана. IP хязгаарыг API түлхүүр бүрт тусад нь тохируулна: Хянах самбарын API түлхүүр хэсэгт тухайн API түлхүүрийн IP хязгаар талбарт хаягуудаа нэмнэ. Тест болон бодит API түлхүүр тус бүр өөрийн жагсаалттай.
Webhook-ийн secret
Webhook-ийн secret нь API түлхүүрээс тусдаа бөгөөд горим бүрд нэг байна. Үүнийг POST /v1/webhook/rotate-secret-ээр солино. Дэлгэрэнгүйг Webhook ба signature хэсгээс үзнэ үү.
Дараагийн алхам
Энэ хуудас тус болсон уу?