README

Pakej ini dibangunkan adalah untuk memudahkan pembangunan sistem di Bahagian Sistem Maklumat UITM (BSM). Pakej ini bertujuan adalah untuk menyokong perkhidmatan web services integrasi.

Gambaran keseluruhan Projek (Project overview)

Project ini dibangun menggunakan Laravel Framework versi 9.x dan PHP versi 8.1.

Selain itu, beberapa pakej (Packages) atau library yang digunakan dalam projek, berikut adalah pakej tersebut :-

1. HTTP Client

Pemasangan Cepat (Quick Installation)

1. laksanakan arahan berikut didalam folder project anda

    composer require uitm/ws-integrasi && php artisan vendor:publish --provider="WSIntegrasi\WSIntegrasiServiceProvider"
   

2. Tetapkan maklumat seperti berikut (Sila hubungi unit Integrasi, Bahagian Sistem Maklumat. PPII untuk maklumat lanjut) :-

    INTEGRASI_URL=
    INTEGRASI_URL_CDN=
    INTEGRASI_BEARER_TOKEN=
   

Web Services Integrasi

Berikut adalah Kaedah Web Services Tersedia (Available Web Service Methods) yang boleh digunakan untuk mendapatkan maklumat daripda sistem lain:-

1. Maklumat staf UiTM berdasarkan no pekerja

    use WSIntegrasi\Facades\WSIntegrasi;
    ...
    WSIntegrasi::userByStaffNo(<no_pekerja>)->json();
   

2. Gambar warga UiTM berdasarkan no warga (No Pekerja/No Pelajar)

    use WSIntegrasi\Facades\WSIntegrasi;
    ...
    WSIntegrasi::pictureWarga(<no_warga>); //Return image based 64
   

3. Senarai data kampus

    use WSIntegrasi\Facades\WSIntegrasi;
    ...
    WSIntegrasi::campuses->json();
   

4. Senarai data fakulti

    use WSIntegrasi\Facades\WSIntegrasi;
    ...
    WSIntegrasi::faculties->json();
   

5. Senarai data programs

    use WSIntegrasi\Facades\WSIntegrasi;
    ...
    WSIntegrasi::programs->json();
   

6. Senarai data programs

    use WSIntegrasi\Facades\WSIntegrasi;
    ...
    WSIntegrasi::programs->json();
   

7. Senarai data jabatan

    use WSIntegrasi\Facades\WSIntegrasi;
    ...
    WSIntegrasi::jabatan->json();
   

8. Senarai data jawatan

    use WSIntegrasi\Facades\WSIntegrasi;
    ...
    WSIntegrasi::jawatan->json();
   

9. Request data : GET

    use WSIntegrasi\Facades\WSIntegrasi;
    ...
    # path : url request
    # data : array
    #        optional
    WSIntegrasi::get('<path>', '<data>')->json();
       
    # Jika menggunakan URL digital campus
    use WSIntegrasi\Facades\WSIntegrasi;
    ...
    # path : url request
    # data : array
    #        optional
    WSIntegrasi::digitalCampus()->get('<path>', '<data>')->json();
   

10. Request data : POST

     use WSIntegrasi\Facades\WSIntegrasi;
     ...
     # path : url request
     # data : array
     #        optional
     WSIntegrasi::post('<path>', '<data>')->json();
        
     # Jika menggunakan URL digital campus
     use WSIntegrasi\Facades\WSIntegrasi;
     ...
     # path : url request
     # data : array
     #        optional
     WSIntegrasi::digitalCampus()->post('<path>', '<data>')->json();