Dokumentasi API : User – Users

Pada halaman ini, akan dijelaskan penggunaaan API untuk manipulasi data user yang meliputi : melihat daftar user, membuat user baru, melihat details user, membaharui data user, mengaktif dan nonaktifkan user, dan me-reset password user.

Daftar Isi Tutup

5. API Activate/Deactivate

5.1. Request

5.2. Response

6. API Reset Password

6.1. Request

6.2. Response

API List

Method ini digunakan untuk mendapatkan data daftar user yang terdaftar pada sistem.

Request

METHOD	URL
GET	http://apiv2.mitrabunso.com/public/user/users/list/{id_user}/{offsite}/{limit};

Parameter yang digunakan pada method ini adalah sebagai berikut:

METHOD	Parameter	Wajib	Tipe	Keterangan
GET	id_user	YA	STRING	36 character id user
GET	offsite	YA	int	offsite data
GET	limit	YA	int	limit data
HEAD	Authorization	YA	Bearer Token	Bearer Token Login
GET	q	TIDAK	STRING	Parameter untuk pencarian
GET	orderBy	TIDAK	STRING	Parameter untuk pengurutan berdasarkan data

Response

{
    "message": "Data retrieved successfully",
    "show": "1",
    "total": 21,
    "data": [
        {
            "id": "0f6a4ab7-5429-44d9-89f0-bc3aa99db9ef",
            "companyNumber": "081270253300",
            "companyName": "REDANGUS",
            "email": "muhammadaldozagokuswoyo23@gmail.com",
            "firstName": "Muhammad",
            "lastName": "Aldo Zago Kuswoyo",
            "companyCode": "REDX",
            "status": "ACTIVE",
            "created": null,
            "updated": null
        }
    ]
}

API Create

Method ini digunakan untuk mendaftarkan user baru ke dalam sistem.

Request

METHOD	URL
POST	http://apiv2.mitrabunso.com/public/user/users/create/{id_user}

Parameter yang digunakan pada method ini adalah sebagai berikut:

METHOD	Parameter	Wajib	Tipe	Keterangan
GET	id_user	YA	STRING	36 charakter id user
HEAD	Authorization	YA	Bearer Token	Bearer Token Login
POST	email	YA	STRING	Email user baru
POST	password	YA	STRING	Password. minimal karakter adalah 8 dengan maksimal 100 karakter
POST	company_name	YA	STRING	Nama perusahaan
POST	dscode	YA	STRING	Code perusahaan
POST	company_number	YA	STRING	Nomor teleporn perusahaan
POST	fname	YA	STRING	Nama depan user
POST	lname	YA	STRING	Nama belakang user

Response

{
    "message": "Data updated successfully",
    "data": true
}

API Update

Method ini digunakan untuk mengubah data marketplace.

Request

METHOD	URL
PUT	http://apiv2.mitrabunso.com/public/user/users/update/{id_user}/{id_user_target}

Parameter yang digunakan pada method ini adalah sebagai berikut:

METHOD	Parameter	Wajib	Tipe	Keterangan
GET	id_user	YA	STRING	36 character id user
GET	id_user_target	YA	STRING	36 character id user yang akan diupdate
HEAD	Authorization	YA	Bearer Token	Bearer Token Login
POST	email	TIDAK	STRING	Email user baru
POST	password	TIDAK	STRING	Password. minimal karakter adalah 8 dengan maksimal 100 karakter
POST	company_name	TIDAK	STRING	Nama perusahaan
POST	dscode	TIDAK	STRING	Code perusahaan
POST	company_number	TIDAK	STRING	Nomor teleporn perusahaan
POST	fname	TIDAK	STRING	Nama depan user
POST	lname	TIDAK	STRING	Nama belakang user
POST	status	TIDAK	STRING	Status user. Dapat berupa “ACTIVE”, “INACTIVE”, “RESET”

Response

{
                "message": "Data updated successfully",
                "data": {
                    "password": "$2y$10$YfN4o4kq/hLInand2tcFu.cWzIfsF8IfEWdlYeGq1KdOkotNi.maK",
                    "deleted_at": null,
                    "id": "5854b3fc-79d5-4722-b2cc-6c9c18ceceab",
                    "companyNumber": "0800000000",
                    "companyName": "Redangus Test",
                    "email": "andikatestid2@gmail.com",
                    "firstName": "Andika T2U",
                    "lastName": "Test id2",
                    "companyCode": "REDT1",
                    "status": "ACTIVE",
                    "created": {
                        "date": "2023-05-22 18:35:53.000000",
                        "timezone_type": 3,
                        "timezone": "Asia/Bangkok"
                    },
                    "updated": {
                        "date": "2023-05-29 10:25:26.000000",
                        "timezone_type": 3,
                        "timezone": "Asia/Bangkok"
                    }
                }
            }

API Details

Method ini digunakan untuk mendapatkan data details user.

Request

METHOD	URL
GET	http://apiv2.mitrabunso.com/public/user/users/details/{id_user}/{id_user_target}

Parameter yang digunakan pada method ini adalah sebagai berikut:

METHOD	Parameter	Wajib	Tipe	Keterangan
GET	id_user	YA	STRING	36 character id user
GET	id_user_target	YA	STRING	36 character id user yang ditargetkan
HEAD	Authorization	YA	Bearer Token	Bearer Token Login

Response

{
                "message": "data retrieved successfully",
                "data": {
                    "id": "1832fb55-03bf-4fad-8740-9ba0abdda64c",
                    "companyNumber": "081270253300",
                    "companyName": "REDANGUS",
                    "email": "redangus.hoo@gmail.com",
                    "firstName": "Rudyanto",
                    "lastName": "Ang.",
                    "companyCode": "REDX",
                    "status": "ACTIVE",
                    "created": null,
                    "updated": null
                }
            }

API Activate/Deactivate

Method ini digunakan untuk mengkatifkan atau menon-aktifkan user.

Request

METHOD	URL
GET	http://apiv2.mitrabunso.com/public/user/users/{status}/{id_user}/{id_user_target}

Parameter yang digunakan pada method ini adalah sebagai berikut:

METHOD	Parameter	Wajib	Tipe	Keterangan
GET	status	YA	STRING	Pilihan method untuk merubah status user. Pilihan : “activate” atau “deactivate”
GET	id_user	YA	STRING	36 character id user
GET	id_user_target	YA	STRING	36 character id user yang ditargetkan
HEAD	Authorization	YA	Bearer Token	Bearer Token Login

Response

{
                "message": "Data updated successfully",
                "data": {
                    "password": "$2y$10$YfN4o4kq/hLInand2tcFu.cWzIfsF8IfEWdlYeGq1KdOkotNi.maK",
                    "deleted_at": null,
                    "id": "5854b3fc-79d5-4722-b2cc-6c9c18ceceab",
                    "companyNumber": "0800000000",
                    "companyName": "Redangus Test",
                    "email": "andikatestid2@gmail.com",
                    "firstName": "Andika T2U",
                    "lastName": "Test id2",
                    "companyCode": "REDT1",
                    "status": "ACTIVE",
                    "created": {
                        "date": "2023-05-22 18:35:53.000000",
                        "timezone_type": 3,
                        "timezone": "Asia/Bangkok"
                    },
                    "updated": {
                        "date": "2023-05-29 10:37:26.000000",
                        "timezone_type": 3,
                        "timezone": "Asia/Bangkok"
                    }
                }
            }

API Reset Password

Method ini digunakan untuk me-reset password user sehingga status user dapat berubah mejadi “RESET”, dan dapat memasukkan ulang password yang diinginkan.

Request

METHOD	URL
PUT	http://apiv2.mitrabunso.com/public/user/users/reset/{id_user}/{id_user_target}

Parameter yang digunakan pada method ini adalah sebagai berikut:

METHOD	Parameter	Wajib	Tipe	Keterangan
GET	id_user	YA	STRING	36 character id user
GET	id_user_target	YA	STRING	36 character id user yang ditargetkan
HEAD	Authorization	YA	Bearer Token	Bearer Token Login
POST	password	YA	STRING	Password baru. Minimal 8 karakter dengan maksimal 100 karakter

Response

{
                "message": "Data updated successfully",
                "data": {
                    "password": "$2y$10$LwBq3KOQnr9sZTQUn67Isuov9SH41T4PkH15UmqwdlXKjKIitQdlO",
                    "deleted_at": null,
                    "id": "5854b3fc-79d5-4722-b2cc-6c9c18ceceab",
                    "companyNumber": "0800000000",
                    "companyName": "Redangus Test",
                    "email": "andikatestid2@gmail.com",
                    "firstName": "Andika T2U",
                    "lastName": "Test id2",
                    "companyCode": "REDT1",
                    "status": "RESET",
                    "created": {
                        "date": "2023-05-22 18:35:53.000000",
                        "timezone_type": 3,
                        "timezone": "Asia/Bangkok"
                    },
                    "updated": {
                        "date": "2023-05-29 10:41:08.000000",
                        "timezone_type": 3,
                        "timezone": "Asia/Bangkok"
                    }
                }
            }

API List

Request

Response

API Create

Request

Response

API Update

Request

Response

API Details

Request

Response

API Activate/Deactivate

Request

Response

API Reset Password

Request

Response

You Might Also Like

Dokumentasi API : User – Group

Dokumentasi API : User – Permission

Dokumentasi API : User – Group Permission

Leave a Reply Cancel reply