Authorization

Methods

POST Get authorization token (login) —
POST Get api key (getApiKey) —
GET Password recovery (recovery-password) —
POST User registration (register) —
POST /remote-api/login Get authorization token (login)
Request URL
POST https://app.sms.by/remote-api/login

Parameters

Parameter Location Type Required Description
name formData string Yes Login from personal account
password formData string Yes Password for personal account

Responses

200 — Completed successfully

{
    "status": "ok",
    "token": "f75b3c62b5a6147eff499549e677319c"
}

400 — Incorrect request

404 — Api_key not found

429 — Request limit exceeded

500 — Server is not available

POST /remote-api/getApiKey Get api key (getApiKey)
Request URL
POST https://app.sms.by/remote-api/getApiKey

Parameters

Parameter Location Type Required Description
token formData string Yes Authorization token

Responses

200 — Completed successfully

{
    "status": "ok",
    "api_key": "2f376acefc89c7c04c2424250e6258a7"
}

400 — Incorrect request

404 — Api_key not found

429 — Request limit exceeded

500 — Server is not available

GET /remote-api/recovery-password Password recovery (recovery-password)
Request URL
GET https://app.sms.by/remote-api/recovery-password

Parameters

Parameter Location Type Required Description
email query string Yes Your E-Mail address

Responses

200 — Completed successfully

{
    "status": "OK",
    "message": "You have been sent an email to reset your password"
}

400 — Incorrect request

404 — Page not found

429 — Request limit exceeded

500 — Server is not available

POST /remote-api/register User registration (register)
Request URL
POST https://app.sms.by/remote-api/register

Parameters

Parameter Location Type Required Description
email formData string Yes Email
phone formData string Yes Phone number
token formData string Yes Access token from method (GET get-token)

Responses

200 — Completed successfully

{
    "status": "success",
    "message": "Registration was successful. A confirmation letter with a temporary password will be sent to your email"
}

400 — Incorrect request

422 — Data not verified

429 — Request limit exceeded

500 — Server is not available