README

一个使用HMRC增值税API检查英国增值税号的Laravel包。此包提供了一种简单的方法将增值税号验证集成到您的Laravel应用程序中。

安装

您可以通过composer安装此包。运行以下命令

composer require patrixshah-uk-vat-checker/hmrc-vat-check

配置

安装包后，您需要发布配置文件以自定义API凭据和端点URL。

• 步骤 1：发布配置文件 运行以下Artisan命令以发布配置文件

  php artisan vendor:publish --provider="PatrixshahUKVatChecker\HmrcVatCheck\HmrcVatCheckServiceProvider" --tag=config

  此命令将在您的config目录中创建一个hmrc_vat.php配置文件。

• 步骤 2：设置环境变量 接下来，您需要在您的.env文件中设置所需的变量。向您的.env文件添加以下行

  HMRC_CLIENT_ID=your-client-id
  HMRC_CLIENT_SECRET=your-client-secret
  HMRC_OAUTH2_URL=https://test-api.service.hmrc.gov.uk/oauth/token
  HMRC_GRANT_TYPE=client_credentials
  HMRC_SCOPE=read:vat
  HMRC_CHECK_VAT_NUMBER=https://test-api.service.hmrc.gov.uk/organisations/vat/check-vat-number/lookup

  将占位符替换为您的实际HMRC API凭据和URL。

• 步骤 3：清除配置缓存 为了确保Laravel能识别您的新配置，请清除配置缓存

  php artisan config:clear

使用方法

一旦安装并配置了包，您就可以使用它通过API端点检查增值税号。

API使用示例 该包提供了一个API端点，您可以使用它来检查增值税号。

• 步骤 1：定义路由（可选） 如果您想在您的Laravel应用程序中定义自定义路由，请向您的routes/api.php文件添加以下内容

  use Illuminate\Support\Facades\Route;
  use YourVendorName\HmrcVatCheck\Controllers\VatCheckController;
  Route::post('/api/vat/check', [VatCheckController::class, 'checkVatNumber']);

  如果该路由已在包中定义，则可以跳过此步骤。

• 步骤 2：发送API请求 现在，您可以向/api/vat/check端点发送带有增值税号的POST请求

  curl -X POST http://your-app-url/api/vat/check \
   -H "Content-Type: application/json" \
   -d '{"vat_number": "GB123456789"}'

• 步骤 3：处理响应 如果增值税号有效，您将收到如下JSON响应

  {
      "success": true,
      "data": {
          "target": {
              "name": "MS&AD Insurance",
              "vatNumber": "293129633",
              "address": {
                  "line1": "82 Clemie Close",
                  "postcode": "RM37 4KI",
                  "countryCode": "GB"
              }
          },
          "processingDate": "2024-08-23T13:14:06+01:00"
      }
  }

  如果发生错误或增值税号无效，您将收到如下响应

  {
      "success": false,
      "message": "Error checking VAT number: [Error Details]"
  }

定制

配置HMRC API凭据 您可以通过修改config/hmrc_vat.php文件来更改API凭据和其他设置

return [
    'client_id' => env('HMRC_CLIENT_ID', 'your-client-id'),
    'client_secret' => env('HMRC_CLIENT_SECRET', 'your-client-secret'),
    'oauth2_url' => env('HMRC_OAUTH2_URL', 'https://test-api.service.hmrc.gov.uk/oauth/token'),
    'grant_type' => env('HMRC_GRANT_TYPE', 'client_credentials'),
    'scope' => env('HMRC_SCOPE', 'read:vat'),
    'check_vat_number_url' => env('HMRC_CHECK_VAT_NUMBER', 'https://test-api.service.hmrc.gov.uk/organisations/vat/check-vat-number/lookup'),
];

请确保根据您的需求和您的工作环境更新这些值。

作者

• 姓名： Pratik Shah
• LinkedIn： Pratik Shah

许可证

此包是开源软件，受MIT许可证许可。