README

基于 gusapi/gusapi 包。针对 Laravel 环境进行了适配，以便于集成。

安装

composer require xgrz/laragus

API 密钥（必需）

此包需要 API 密钥。您可以从 GUS 免费获取。官方文档和注册信息可在GUS API找到

获取 API 密钥后，将其放置在 .env 文件中

GUS_API_KEY=c443ml3o4fko4okf4o8b

使用（后端）

<?php

    $vatId = 'VAT_ID_NUMBER';

    Xgrz\LaravelGusDataFetcher\Services\GusService::nip($vatId)->toCollection();
    // or
    Xgrz\LaravelGusDataFetcher\Services\GusService::nip($vatId)->toArray();

通常返回一条记录。例外情况是当企业家也是农民时。实施一种始终检查所有返回数据的解决方案。

方法返回数组/集合。示例

array [
    0 => array [
        "company_name" => "ACME Limited"
        "city" => "Warsaw"
        "post_code" => "02-226"
        "street" => "ul. Kamyczkowa"
        "property_number" => "201"
        "apartment_number" => "21"
        "vat_id" => "9678907766"
    ]
]

使用（Ajax 请求）

默认情况下

• 包公开 api/ajax 路由供外部请求使用
• 默认路由名称是 ajax.gus
• 默认 URI 是 /ajax.gus
• 没有中间件！（路由是公开的！- 请参阅配置部分）
• 您可以在配置文件中修改 URL、路由名称、添加中间件或禁用此功能（请参阅配置部分）

典型的请求应该是这样的

GET: example.com/ajax/gus?vat_id=1231231212

配置

要能够更改默认行为，请执行以下命令发布配置

 php artisan vendor:publish vendor:publish --tag="laragus-config"

配置文件将放置在您的配置应用目录中 (/config/laragus.php)。

阻止 API 暴露

'expose_api_route' => false     // default true

将 expose_api_route 设置为 false 阻止 API 调用。

更改暴露的 API 路由名称

'api_route_name' => 'your_route_name'   // default ajax.gus

为 API 调用设置您自己的路由名称。

更改暴露资源的 URI

'api_uri' => 'gus-data-fetch'   // default ajax/gus

为 API 调用设置您自己的 URL。

使用 Laravel 中间件保护路由

'middleware' => ['web', 'auth']    // default is ['web'] - no middlewares

使用您自己的 Laravel 中间件保护路由。