Public API

Энд method бүрийн гарын үсэг, параметр, буцах утга, алдаа байна. Алхам алхмаар хийх заавар энд байхгүй.

Урьдчилсан нөхцөл

Node.js 18 буюу түүнээс шинэ.
node server.js ажиллаж, baseUrl тэр хаяг байна. Анхны утга нь http://localhost:3000.
register болон login-оос бусад method setToken-оор тавьсан access token шаардана.
Демо өгөгдөл санах ойд байгаа тул серверийг дахин асаахад өмнөх session арилна.
Нууц үг, hash, JWT гарын үсэг нь public API биш. Тэд server.js дотор үлдэнэ.

`constructor`

new SkillSwapClient(baseUrl?)

Параметр

Нэр	Тайлбар
`baseUrl`	Серверийн үндэс. Анхны утга http://localhost:3000

Буцах утга

SkillSwapClient

Алдаа

Код	Хэзээ
Алдаа буцаахгүй

`setToken`

setToken(accessToken)

Параметр

Нэр	Тайлбар
`accessToken`	login-оос авсан access_token

Буцах утга

void

Алдаа

Код	Хэзээ
Алдаа буцаахгүй

`register`

register(input)

Параметр

Нэр	Тайлбар
`input.name`	Нэр
`input.phone`	Утас
`input.email`	Имэйл
`input.password`	8-аас дээш тэмдэгт
`input.skills`	Заавал биш

Буцах утга

RegisterResult, 201

Алдаа

Код	Хэзээ
`400 VALIDATION_ERROR`	Талбар дутуу, нууц үг богино, имэйл давхардсан

`login`

login(email, password)

Параметр

Нэр	Тайлбар
`email`	Жишээ: oyuntsetseg@num.edu.mn
`password`	your_account_password

Буцах утга

LoginResult, 200

Алдаа

Код	Хэзээ
`400 VALIDATION_ERROR`	Талбар дутуу
`401 UNAUTHORIZED`	Имэйл эсвэл нууц үг буруу

Tutorial: Франц хэлний цаг захиалах

`me`

me()

Параметр

Нэр	Тайлбар
Параметр байхгүй

Буцах утга

MeResult, 200

Алдаа

Код	Хэзээ
`401 UNAUTHORIZED`	Token байхгүй

`getProfile`

getProfile(userId)

Параметр

Нэр	Тайлбар
`userId`	Жишээ: usr_4f2a91

Буцах утга

ProfileResult, 200

Алдаа

Код	Хэзээ
`401 UNAUTHORIZED`	Token байхгүй
`404 NOT_FOUND`	Хэрэглэгч байхгүй

Tutorial: Франц хэлний цаг захиалах

`searchSkills`

searchSkills(query)

Параметр

Нэр	Тайлбар
`query.skill`	Нэрийн дэд мөр
`query.category`	Яг таарах ангилал
`query.minRating`	0–5
`query.availableFrom`	ISO-8601

Буцах утга

SearchResult, 200

Алдаа

Код	Хэзээ
`400 VALIDATION_ERROR`	skill болон category хоёул хоосон
`401 UNAUTHORIZED`	Token байхгүй

Tutorial: Франц хэлний цаг захиалах

`listSessions`

listSessions()

Параметр

Нэр	Тайлбар
Параметр байхгүй

Буцах утга

SessionList, 200

Алдаа

Код	Хэзээ
`401 UNAUTHORIZED`	Token байхгүй

`proposeSession`

proposeSession(input)

Параметр

Нэр	Тайлбар
`input.teacherId`	Заагчийн id
`input.skill`	Ур чадвар
`input.startTime`	ISO-8601
`input.endTime`	startTime-аас хойш
`input.credits`	Эерэг бүхэл тоо

Буцах утга

Session, 201, status proposed

Алдаа

Код	Хэзээ
`400 VALIDATION_ERROR`	Талбар, цаг, teacher_id буруу
`401 UNAUTHORIZED`	Token байхгүй
`403 RESTRICTED`	No-show хязгаарлалт
`403 INSUFFICIENT_CREDITS`	Үлдэгдэл хүрэхгүй

Tutorial: Франц хэлний цаг захиалах

`respond`

respond(sessionId, input)

Параметр

Нэр	Тайлбар
`sessionId`	Session id
`input.action`	accept, decline, counter

Буцах утга

Session, 200

Алдаа

Код	Хэзээ
`400 INVALID_STATE`	proposed биш
`400 VALIDATION_ERROR`	action буруу
`401 UNAUTHORIZED`	Token байхгүй
`403 INSUFFICIENT_CREDITS`	accept үед үлдэгдэл хүрэхгүй
`404 NOT_FOUND`	Session олдсонгүй

How-to: санал ирэхэд зөвшөөрөх

`cancel`

cancel(sessionId)

Параметр

Нэр	Тайлбар
`sessionId`	Session id

Буцах утга

Session, 200, status cancelled

Алдаа

Код	Хэзээ
`400 INVALID_STATE`	Цуцлах төлөвт биш
`401 UNAUTHORIZED`	Token байхгүй
`404 NOT_FOUND`	Session олдсонгүй

`checkIn`

checkIn(sessionId, role)

Параметр

Нэр	Тайлбар
`sessionId`	Session id
`role`	teacher эсвэл learner

Буцах утга

Session, 200

Алдаа

Код	Хэзээ
`400 VALIDATION_ERROR`	role буруу
`400 INVALID_STATE`	confirmed биш
`401 UNAUTHORIZED`	Token байхгүй
`404 NOT_FOUND`	Session олдсонгүй
`409 INSUFFICIENT_CREDITS`	Шилжүүлэх үед үлдэгдэл хүрэхгүй

How-to: check-in хийж credit шилжүүлэх

`reportNoShow`

reportNoShow(sessionId, input)

Параметр

Нэр	Тайлбар
`sessionId`	Session id
`input.absentUserId`	Ирээгүй оролцогч
`input.comment`	Заавал биш

Буцах утга

NoShowResult, 200

Алдаа

Код	Хэзээ
`400 VALIDATION_ERROR`	absent_user_id буруу
`400 INVALID_STATE`	confirmed биш
`400 NO_SHOW_TOO_EARLY`	Session эхлээгүй
`400 NO_SHOW_WINDOW_CLOSED`	Дууссанаас хойш 1 цаг өнгөрсөн
`401 UNAUTHORIZED`	Token байхгүй
`404 NOT_FOUND`	Session олдсонгүй

How-to: ирээгүй хүнийг мэдээлэх

`rate`

rate(sessionId, input)

Параметр

Нэр	Тайлбар
`sessionId`	Session id
`input.stars`	1–5
`input.comment`	Заавал биш

Буцах утга

RateResult, 200

Алдаа

Код	Хэзээ
`400 VALIDATION_ERROR`	stars буруу
`400 INVALID_STATE`	completed биш
`400 ALREADY_RATED`	Дахин үнэлгээ
`401 UNAUTHORIZED`	Token байхгүй
`404 NOT_FOUND`	Session олдсонгүй

`listMessages`

listMessages(sessionId)

Параметр

Нэр	Тайлбар
`sessionId`	Session id

Буцах утга

MessageList, 200

Алдаа

Код	Хэзээ
`401 UNAUTHORIZED`	Token байхгүй
`404 NOT_FOUND`	Session олдсонгүй

`postMessage`

postMessage(sessionId, text)

Параметр

Нэр	Тайлбар
`sessionId`	Session id
`text`	Хамгийн ихдээ 500 тэмдэгт

Буцах утга

ChatMessage, 201

Алдаа

Код	Хэзээ
`400 VALIDATION_ERROR`	text дутуу
`401 UNAUTHORIZED`	Token байхгүй
`404 NOT_FOUND`	Session олдсонгүй

`flagSession`

flagSession(sessionId, reason)

Параметр

Нэр	Тайлбар
`sessionId`	Session id
`reason`	Маргааны шалтгаан

Буцах утга

FlagResult, 201

Алдаа

Код	Хэзээ
`400 VALIDATION_ERROR`	reason дутуу
`400 INVALID_STATE`	completed биш
`400 FLAG_WINDOW_CLOSED`	72 цаг өнгөрсөн
`400 ALREADY_FLAGGED`	Давхар flag
`401 UNAUTHORIZED`	Token байхгүй
`404 NOT_FOUND`	Session олдсонгүй

`getBalance`

getBalance()

Параметр

Нэр	Тайлбар
Параметр байхгүй

Буцах утга

CreditBalance, 200

Алдаа

Код	Хэзээ
`401 UNAUTHORIZED`	Token байхгүй

Tutorial: Франц хэлний цаг захиалах

`getLedger`

getLedger()

Параметр

Нэр	Тайлбар
Параметр байхгүй

Буцах утга

LedgerResult, 200

Алдаа

Код	Хэзээ
`401 UNAUTHORIZED`	Token байхгүй

`listNotifications`

listNotifications()

Параметр

Нэр	Тайлбар
Параметр байхгүй

Буцах утга

NotificationResult, 200

Алдаа

Код	Хэзээ
`401 UNAUTHORIZED`	Token байхгүй

`subscribeWebhook`

subscribeWebhook(input)

Параметр

Нэр	Тайлбар
`input.callbackUrl`	https URL
`input.events`	WEBHOOK_EVENTS-ийн дэд олонлог

Буцах утга

WebhookResult, 201

Алдаа

Код	Хэзээ
`400 VALIDATION_ERROR`	URL эсвэл event буруу
`401 UNAUTHORIZED`	Token байхгүй

`adminDashboard`

adminDashboard()

Параметр

Нэр	Тайлбар
Параметр байхгүй

Буцах утга

AdminDashboard, 200

Алдаа

Код	Хэзээ
`401 UNAUTHORIZED`	Token байхгүй
`403 FORBIDDEN`	Admin биш

`resolveFlag`

resolveFlag(flagId, input)

Параметр

Нэр	Тайлбар
`flagId`	Flag id
`input.decision`	approve эсвэл reject

Буцах утга

FlagResult, 200

Алдаа

Код	Хэзээ
`400 VALIDATION_ERROR`	decision буруу
`401 UNAUTHORIZED`	Token байхгүй
`403 FORBIDDEN`	Admin биш
`404 NOT_FOUND`	Нээлттэй flag байхгүй

`auditLog`

auditLog()

Параметр

Нэр	Тайлбар
Параметр байхгүй

Буцах утга

AuditLogResult, 200

Алдаа

Код	Хэзээ
`401 UNAUTHORIZED`	Token байхгүй
`403 FORBIDDEN`	Admin биш

`SkillSwapError`

new SkillSwapError(status, code, message, body?)

Параметр

Нэр	Тайлбар
`status`	HTTP төлөв
`code`	Жишээ: VALIDATION_ERROR
`message`	Серверийн мессеж
`body`	Заавал биш, бүтэн JSON

Буцах утга

SkillSwapError

Алдаа

Код	Хэзээ
Алдаа буцаахгүй

`WEBHOOK_EVENTS`

WEBHOOK_EVENTS

Параметр

Нэр	Тайлбар
Параметр байхгүй

Буцах утга

readonly string[]: session.confirmed, session.completed, session.cancelled, credit.transferred

Алдаа

Код	Хэзээ
Алдаа буцаахгүй