API Test

User and group management API with permissions management. This test has been prepared with the following technologies:

• docker containers bitnami/laravel
• Laravel 9 + Sanctum
• MariaDB
• Composer

Models location

As part of the test, a domain and database model has been requested. The models are located in the 'Documentation' directory.

How to Install and Run

For launching the API in a docker environment (it requires Docker installer locally):

• Install dependencies:

    cd api
    composer install
  

• Initialize containers:

    docker compose up -d
  

• Launch migrations:

    docker exec internations-test-InterNationsApi-1 php artisan migrate --seed
  

You can launch the web server locally (it requires PHP with extension=pdo_mysql enabled):

    docker stop internations-test-InterNationsApi-1

Rename the .env.example to .env

    php artisan serve

How to use the API

Postman must be configured with the following headers:

• Content-Type: application/json
• Accept: application/json

These headers have already been configured in the Postman's collections included in 'Documentation/Postman Collections'.

Auth related endpoints

/api/v1/auth

Used to retrieve the auth token. This endpoint expects a JSON string with the following format:

Admin user:

{
    "user_name": "admin_user",
    "password": "123pwd"
}

Regular user:

{
    "user_name": "admin_user",
    "password": "123pwd"
}

The obtained token must be configured as Bearer Token for all the requests.

---

User related endpoints

/api/v1/user/add

This endpoint expects a JSON string with the following format:

{
    "id_role": 2,
    "user_name": "admin_user",
    "password": "123pwd",
    "password_confirmation": "123pwd"
}

---

/api/v1/user/delete/{id}

This endpoint expects the user's id to be send in the path

---

/api/v1/user/whoami

This endpoint returns the current logged user

---

/api/v1/user/logout

This endpoint revokes the current logged user's token

Group related endpoints

/api/v1/group/add

This endpoint expects a JSON string with the following format:

{
    "group_name": "InterNations cool people"
}

---

/api/v1/group/delete/{id}

This endpoint expects the group's id to be send in the path

---

/api/v1/group/{id}/ad/{user_id}

This endpoint adds a given user to the given group. Both variables must be sent in the PATH

---

/api/v1/group/{id}/remove/{user_id}

This endpoint removes a given user to the given group. Both variables must be sent in the PATH

---