ArtLab API

Artlab -тай холбогдоход шаардлагатай мэдээллийг хүргэхийг зорилоо.

Artlab-API нь ерөнхий 2 хэсгээс бүтнэ. Эхнийх нь Login буюу authorization token авах хэсэг. Хоёр дахь нь бусад хэсэг буюу шаардлагатай мэдээллээ авах хэсэг. Login-с бусад бүх хэсэг нь authorization token ашигладаг. Token-оо request бүрийнхээ header-т нь хийж явуулна. (Authorization: Bearer TOKEN)

Ерөнхий загвар

Хэрэглэгчийн API-User бүр өөрийн гэсэн хэрэглэгчийн нэр, нууц үгтэй. Түүнийгээ ашиглан API-руу логин хийж, token-оо авна. Token-ны амьдрах хугацаа нь 1 цаг байна. Хэрэв хүсвэл байнгын (expire хийгдэггүй) token авч болно.

Амжилттай болох тохиолдолд бүх функц 200 status code-той буцна. Хэрэв username, password буруу бол эсвэл authorization token буруу бол 401 status code буцна. Хэрэв сервер дээр алдаа гарвал 500 кодтой error буцна.

1. Login хийх

Энэ функц нь хэрэглэгчийн мэдээллийг шалгаж, token буцаах ганц л үүрэгтэй. Амжилттай болбол, доор харуулсантай төстэй json-г response body хэсэгт буцаана.

{
    “successful”: true,
    “value”: 60603052285493249 // Хэрэглэгчийн ID
}

Харин token-оо болохоор, response header-т нь буцаана.

Postman application screenshot

Login хийх функцийн мэдээлэл:

URL         : https://api.artlab.mn/auth/login
Method      : POST
Content-type: application/json

Login хийх үед, username/password –с гадна, type хэрэг болно. Энэ нь тухайн хэрэглэгчийн төрлийг заах юм. Хэрэглэгчийн нэр, нууц үг, хэрэглэгчийн төрлийг ArtLab-с өгнө.

Жишээ input json:

{
    "username":"myname@mycompany",
    "password":"mypassword",
    "type":"api"
}

2. Бусад resource

Бусад resource болон функцуудыг дуудахын тулд, /auth/login -с ирсэн token-ыг, request-нхээ header-т хийж өгч дуудна.

Authorization token-оо ингэж явуулна

Жишээ болгож /auth/check -г дуудаж болно. Энэ функц нь тухайн token-ыг шалгаж, ямар төрлийн хэрэглэгч вэ гэдгийг нь тодорхойлж буцаадаг юм.

token шалгах функцийн мэдээлэл

3. Хавсралт

• Postman collection-ны export: link
• API дуудах жишээ client JAVA хэл дээр: link