REST API Documentation

Contents

1. Login

• Create a new user
• Login a user
• Logout a user

2. Tribes

• Create a new tribe
• Add a user to a tribe
• Get a list of all users that are a part of a tribe

===

1. Login

POST /users/new

Creates a new user

Parameters

{
    username:   string,
    password:   string,
    first_name: string,
    last_name:  string
}

Body

{
    token: integer
}

===

POST /login

Creates a new sessions and returns the session token

Parameters

{
    username:   string,
    password:   string
}

Body

{
    token: integer
}

===

POST /logout

Destroys the current session

Parameters

{
    token: string
}

===

2. Tribes

POST /tribes/new

Create a new tribe and add creator to it

Parameters

{
    name:   string,
    token:   string
}

===

POST /tribes/:tribe_id/add/users/:user_id

Adds user to said tribe. FRIEND AUTHENTICATION NEEDS TO BE ADDED!

Parameters

none...

===

GET /tribes/:tribe_id/users

Get a list of all users in a tribe

Parameters

{
    token: string
}

Body

{
    users: [
        {
            username: string,
            name: string,
            id: integer,
            image: string (url)
        },
        ...
    ]
}