yLorde.com.br Rust API

User (/api/user)

check_username.rs

END-POINT:

/api/user/check_username/{username}

METHOD: GET

DETAILS:

PATH:

{username}: String // Ex.: Lord

RETURN:

Available:

{
    "status": "success",
    "message": "Username available!",
}

Not Available:

{
    "message": "Username indisponível!",
    "status": "success"
}

check_email.rs

END-POINT:

/api/user/check_email/{email}

METHOD: GET

DETAILS:

PATH:

{email}: String // Ex.: contato@ylorde.com.br

RETURN:

Available:

{
    "status": "success",
    "message": "Email available!",
}

Not Available:

{
    "message": "Email indisponível!",
    "status": "success"
}

create_user.rs

END-POINT:

/api/user/register

METHOD: POST

DETAILS:

BODY:

{
    "email": String,
    "password": String,
    "username": String,
    "display_name": String
}

RETURN:

{
    "created_at": Timestamp,
    "display_name": String,
    "message": "usuário criado com sucesso!",
    "public_id": String(12),
    "status": "success",
    "token": String(64),
    "username": String
}

get_all_users.rs get_user_by_id.rs

login_user.rs

END-POINT:

/api/user/login

DETAILS:

BODY:

{
    "email": String,
    "password": String
}

RETURN:

{
    "created_at": Timestamp,
    "display_name": String,
    "message": "Logado com sucesso!",
    "public_id": String(12),
    "status": "success",
    "token": String(64),
    "username": String
}

Task (/api/task)

create_task.rs delete_task_by_id.rs get_all_tasks.rs get_task_by_id.rs update_task_by_id.rs

VShelf (/api/vshelf)

delete_title.rs

END-POINT:

/api/vshelf/title/{id}

METHOD: DELETE

DETAILS:

PATH:

{id}: Uuid // Ex.: 02d06e4f-7e33-4f22-965c-e2d155a16617

BODY:

{
    "owner_id": "827833807067",
    "title_id": "78a839a3-d695-4e42-9dc2-b10f19bfaef5"
}

get_title_detail.rs

END-POINT:

/api/vshelf/{owner_id}/{title_id}

METHOD: GET

DETAILS:

PATH:

{owner_id}: String // Ex.: 827833807067
{title_id}: String // Ex.: 78a839a3-d695-4e42-9dc2-b10f19bfaef5

RETURN:

{
    "status": "success",
    "title": Object
}

get_user_titles.rs

END-POINT:

/api/vshelf/title/{owner_id}

METHOD: GET

DETAILS:

PATH:

{owner_id}: String // Ex.: 827833807067

RETURN:

{
    "size": Number,
    "status": "success",
    "titles": Array,
}

upload_title.rs

END-POINT:

/api/vshelf/title

METHOD: POST

DETAILS:

BODY:

{
    "title_id": String,
    "owner_id": String,
    "titulo": String,
    "nota": String,
    "stream": String,
    "classificacao": String,
    "genero": String,
    "Status": String,
    "tipo": String,
    "estrelas": String,
    "image": String,
    "background": String,
    "sinopse": String,
}

RETURN:

{
    "id": Uuid,
    "message": "Title uploaded successfully",
    "status": "success"
}

Minecraft

get_all_plugins.rs

END-POINT:

/api/minecraft/plugin/all

METHOD: GET

RETURN:

{
    "plugins": [],
    "status": "success"
}

---

get_plugin_by_id.rs

END-POINT:

/api/minecraft/plugin/{id}

METHOD: GET

DETAILS:

PATH:

{id}: Uuid // Ex.: 534e5057-9155-4d33-8362-83fbaa41e690

RETURN:

{
    "status": "success",
    "plugin": []
}