werify / id-laravel
werify id pacakge for laravel.
This package is auto-updated.
Last update: 2024-10-24 17:04:56 UTC
README
id/laravel is a library for connecting with Werify id (see more https://id.werify.net/).
Requirements
- PHP 8.0 and above.
- Built-in libcurl support.
- Laravel 7
Installation
For running this example, you need to install werify/id-laravel
library before. It can be done by two different methods:
1. Using Composer
You can install the library via Composer. If you don't already have Composer installed, first install it by following one of these instructions depends on your OS of choice:
- Composer installation instruction for Windows
- Composer installation instruction for Mac OS X and Linux
After composer is installed, Then run the following command to install the Omise-PHP library:
php composer.phar install
Please see configuration section below for configuring your Omise Keys.
2. Manually
If you're not using Composer, you can also clone werify/id-laravel
repository into the directory of sample code that you just installed this repository:
git clone https://github.com/Werify/id-laravel
However, using Composer is recommended as you can easily keep the library up-to-date. After cloning the repository, you need to replace line 3 in config.php
from
3: require_once 'vendor/autoload.php';
to
3: require_once 'werify/id-laravel';
Please see configuration section below for configuring your Omise Keys.
Configuration
After you installed werify/id-laravel
library already. Next, you need to configure id-laravel. you can publish configuration files and see config in config/auth-service
config file.
Usage
this package publishes routes and jobs to connect to werify id service.
jobs
jobs published under Werify\IdLaravel\Jobs
namespace are :
- GetUserProfileJob
- GetUserProfileFinancialInformationJob
- GetUserProfileMetasJob
- GetUserProfileNumbersJob
- RequestOTPJob
- VerifyOTPJob
- GetUserProfileEducationJob
Routes
- GET|HEAD api/werify/request-otp
- GET|HEAD api/werify/verify-otp
request otp:
route: api/werify/request-otp params:
- identifier (string)
response:
- id (string)
- hash(string)
- otp(string)
verify otp:
route: api/werify/verify-otp params:
- id (string)
- hash(string)
- otp(string)
response:
- user info and access_token
changelog
2022/04/07 :
- updated readme file
- package added in packagist
2022/04/05 :
- init
- routes for request and verify otp
- jobs for get profile information