jsadways/data-api

There is no license information available for the latest version (1.0.14) of this package.

1.0.14 2025-05-13 08:49 UTC

Unknown License

• Js-Adways

README

composer require jsadways/data-api

Edit .env file

if you use the old repository version add this to .env file

REPOSITORY_VERSION=0

The defined route url in this package

1. Used in local backend, to receive request from frontend and pass request to the second url below in another system

POST /api/data_api/fetch

parameters

{
    system : 'string, the system name you want to get data, which defined in HR system',
    repository : 'string, the repository name you what to get data in the target system',
    condition : 'json, the json condition you wnat to filter out the data, the struce must be the scopFilter package defined'
}

response

{
    data : 'json, the data you filter out from other system'
}

1. Used in other system backend, for filter out data using repository

***We doesn't recommend using this url directly***

GET /api/data_api/get

parameters

{
    repository : 'string, the repository name you what to get data in the target system',
    condition : 'json, the json condition you wnat to filter out the data, the struce must be the scopFilter package defined'
}

response

{
    data : 'json, the data you filter out from other system'
}

1. Used in other system backend, for call the service api

POST /api/data_api/service

parameters

{
    system : 'string, the system name you want to get data, which defined in HR system',
    api : 'string, the api path you want to call defined in an other system, ec: verify_copany',
    token: 'string, Bearer token to verify your permission',
    payload: 'Object, the payload api need'
}

response

{
    data : 'json, the api response'
}

1. Use Command to list all system service api

php artisan data-api:list

response

+-------------+
| system name |
+-------------+
+--------+--------------------------------+------------+---------+--------+----------+----------------+
| Method | URI                            | Parameters |         |        |          |                |
+--------+--------------------------------+------------+---------+--------+----------+----------------+
| POST   | the api url                    |            | Name    | Type   | Required | Description    |
|        |                                | 0          |         |        |          |                |
|        |                                | 1          |         |        |          |                |
+--------+--------------------------------+------------+---------+--------+----------+----------------+

Examples

1. Call route url post from frontend

code

axios.post('local_backend/api/data_api/fetch',{
    system: 'crm',
    repository: 'customer',
    condition: '{"filter":{"id_number_eq":"27743336"},"per_page":"0"}'
})

description

frontend post to 'local_backend/api/data_api/fetch', 
to get customer data from crm system, 
where id_number column equals to '27743336'

response

{   "status_code":200,
    "data":
    [
        {
            "id":1,
            "created_at":"2024-09-19T08:43:00.000000Z",
            "name":"JS-Adways Group",
            "short_name":"js",
            "en_name":"js adways",
            "id_number":"27743336",
            "zip_code":"110",
            "address":"R.O.C",
            "finance_email":null,
            "type":1,
            "memo":null,
            "contact_list":[],
            "identity_list":
            [
                {
                    "id":1,
                    "created_at":"2024-09-19T08:43:00.000000Z",
                    "customer_id":1,
                    "identity":1
                },
                {
                    "id":2,
                    "created_at":"2024-09-19T08:43:00.000000Z",
                    "customer_id":1,
                    "identity":2
                }
            ]
        }
    ]
}

1. Call Service from backend system

code

• use service

use Jsadways\DataApi\Core\Services\Cross\Dtos\CrossDataDto;
use Jsadways\DataApi\Services\Cross\CrossService;

$payload = [
        'system' => 'crm',
        'repository' => 'customer',
        'condition' => '{"filter":{"id_number_eq":"27743336"},"per_page":"0"}'
];
$result = (new CrossService())->fetch(new CrossDataDto(...$payload));

• use static method

use Jsadways\DataApi\Core\Services\Cross\Dtos\CrossDataDto;
use Jsadways\DataApi\Facades\CrossFacade;

$payload = [
        'system' => 'crm',
        'repository' => 'customer',
        'condition' => '{"filter":{"id_number_eq":"27743336"},"per_page":"0"}'
];
$result = CrossFacade::fetch(new CrossDataDto(...$payload));

1. Call Service API

code

• use service

use Jsadways\DataApi\Core\Services\Cross\Dtos\CrossServiceDto;
use Jsadways\DataApi\Services\Cross\CrossService;

$payload = [
        'system' => 'crm',
        'token' => 'Bearer XXXXXXXXXXXXXX',
        'api => 'company_verify'
        'payload' => [
             'id_number' => '27743336',
             'name' => '傑思愛德威媒體股份有限公司'
        ]
];
$result = (new CrossService())->fetch(new CrossServiceDto(...$payload));

1. Use Command to list all system service api

code

• php artisan

php artisan data-api:list

• response

+-----+
| CRM |
+-----+
+--------+--------------------------------+------------+---------+--------+----------+--------------------------------------------------------------------------+
| Method | URI                            | Parameters |         |        |          |                                                                          |
+--------+--------------------------------+------------+---------+--------+----------+--------------------------------------------------------------------------+
| POST   | api/service_api/company_verify |            | Name    | Type   | Required | Description                                                              |
|        |                                | 0          | title   | string | 1        | 標題                                                                      |
|        |                                | 1          | content | string | 1        | 內容文字內容文字內容文字內容文字內容文字內容文字                                 |
+--------+--------------------------------+------------+---------+--------+----------+--------------------------------------------------------------------------+