rouتموت/rouتموت-sirene-bundle

用于与 Symfony 6 一起使用 INSEE Sirene API 的包

v1.1.1 2024-07-13 12:37 UTC

This package is auto-updated.

Last update: 2024-09-13 12:56:52 UTC


README

用于与 Symfony 6 一起使用 INSEE Sirene API 的包

手动安装

请确保全局已安装 Composer,如 Composer 文档中的 安装章节 所述。

步骤 1:创建配置文件

创建配置文件 config/packages/routmoute_sirene.yaml,并根据需要修改作用域。

// config/packages/routmoute_sirene.yaml

routmoute_sirene:
    consumer_key: '%env(ROUTMOUTE_SIRENE_CONSUMER_KEY)%'
    consumer_secret: '%env(ROUTMOUTE_SIRENE_CONSUMER_SECRET)%'

配置

步骤 1:创建您的 INSEE 应用程序

  • 访问 https://api.insee.fr
  • 创建新应用程序
  • 复制下一步的 consumer-keyconsumer-secret

步骤 2:创建您的环境变量

将以下环境变量添加到您的 .env 文件中。

ROUTMOUTE_SIRENE_CONSUMER_KEY=YourConsumerKey
ROUTMOUTE_SIRENE_CONSUMER_SECRET=YourConsumerSecret

用法

在控制器中的示例用法

<?php
namespace App\Controller;

use Routmoute\Bundle\RoutmouteSireneBundle\Service\RoutmouteSireneApiService;

class MyController extends AbstractController
{
    public function index(RoutmouteSireneApiService $sireneAPI)
    {
        // search company by siret
        $companyInfos = $sireneAPI->siret("<siret>");

        // search company by siren
        $companyInfos = $sireneAPI->siren("<siren>");

        /*
        search company by etablissement infos
            Array of search (required)
            [
                "city" => "libelleCommuneEtablissement",
                "cp" => "codePostalEtablissement",
                "company" => "denominationUniteLegale",
                "sigle" => "sigleUniteLegale",
                "ape" => "activitePrincipaleUniteLegale",
                "cj" => "categorieJuridiqueUniteLegale"
            ]

            orderBy (default "siren")
            "siret" or "siren"

            Int page (default 1)

            Int number of results by page (default 20)
        */
        $companyInfos = $sireneAPI->searchEtablissement([
            "city" => "PARIS"
        ], "siren", 1, 10);
    }
}

参数

consumer_key

必需 由 insee 提供的 consumer_key

consumer_secret

必需 由 insee 提供的 consumer_secret