/SurakshaApi

Primary LanguagePHPApache License 2.0Apache-2.0

Suraksha API

Overview

The Suraksha API will connect the Sri Lanka Insurance Corporation’s (SLIC) system and Student Information System (SIS) of the Ministry of Education, Sri Lanka to make the claiming processes easier and accurate. The main Objective of the Suraksha API is to provide SLIC with necessary information from the SIS database and store the claim details in the SIS database.

Setting-up the server

To run the server, first a setup is needed:

(1) Copy .env.example file and paste to the same root directory.

(2) Change the copied file to .env.

(3) Open .env.

(4) Configure the API_KEY. The default API_KEY is SurakshaAPI@123.

API_KEY=SurakshaAPI@123

(5) Configure the Database Connection.

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=
DB_USERNAME=root
DB_PASSWORD=

(6) To install Composer, run:

composer install

(7) To generate the APP_KEY, run:

php artisan key:generate

(8) To run the migrations, run:

php artisan migrate

Running the server

To run the server, run:

php artisan serve

To view the application:

open http://127.0.0.1:8000

To view the Swagger UI interface:

open http://127.0.0.1:8000/api/documentation