daizuke85a/freee-accounting-sdk

会计freee PHP SDK

维护者

详细信息

github.com/daisuke85a/freee-accounting-sdk-php

主页

源代码

安装: 5

依赖: 0

建议者: 0

安全: 0

星数: 0

关注者: 1

分支: 9

v2.3.0 2021-03-24 03:22 UTC

Requires

Requires (Dev)

MIT 1c0e6dff20f36b41448a9db11be29ccc2e9b2c7f

phprestapisdkopenapiopenapitoolsopenapi-generatorfreee

This package is not auto-updated.

Last update: 2024-10-03 22:46:41 UTC

README

这是使用PHP访问会计freee API的SDK。

有关会计freee API的详细信息，请参阅会计API概要 | freee开发者社区。

此SDK根据不同的发布版本，内部使用的API版本不同。

  • 2.0.0及以后 - 支持会计freee API的新API版本(v2020-06-15)。
  • 2.0.0以下 - 使用会计freee API的旧API版本。由于旧API的提供结束，从2020年12月开始不可使用。

目录

教程

以下将说明使用会计freee PHP SDK的步骤。

先决条件

在利用此SDK之前，请确认以下内容。

  • 拥有freee本体的账户
  • 了解PHP基础知识

freee本体的账户在在freee应用商店中注册应用程序时是必需的。

有关freee API的详细信息，请参阅教程指南。

有关PHP的基础知识，请参阅PHP: PHP手册 - 手册。

执行环境

此存储库假定了以下环境。

  • PHP 7.2以上
  • composer

此存储库针对PHP 7.1以上版本。如果没有PHP执行环境，请参考PHP: 安装和设置 - 手册准备环境。此外，请从composer安装。

在freee应用商店中注册应用程序

要获取此SDK中使用的client_id和client_secret，请在freee应用商店的开发者页面中注册应用程序。

请参考教程 | freee应用商店注册应用程序。

要与此SDK连接，请将回调URL设置为https://:8000/auth-callback。

示例执行方法

WebApp的示例

WebApp的示例执行环境

示例基于Laravel 7.x创建。执行示例时，除了上述执行环境外，还需要准备以下内容。

  • PHP 7.2.5以上
    • BCMath PHP扩展
    • Ctype PHP扩展
    • JSON PHP扩展
    • Mbstring PHP扩展
    • OpenSSL PHP扩展
    • PDO PHP扩展
    • Tokenizer PHP扩展
    • XML PHP扩展
  • composer
  • Node.js（在生成UI时使用npm）
WebApp的示例执行环境（Docker）

此外，为使用Docker的用户提供了包含上述执行环境的Dockerfile和docker-compose.yaml。使用时，请参考以下说明。

cd <本リポジトリのクローン先ディレクトリ>
cd samples
docker-compose build
docker-compose up -d
docker exec -it samples_webapp_1 /bin/bash

执行上述操作后，可以登录docker容器的/usr/src/app。此目录已挂载了本存储库的samples/BasicWebApp。请适当修改以下说明以使用。

WebApp的示例执行步骤

在克隆此存储库后，使用PowerShell或bash等终端切换到目录中。

cd <本リポジトリのクローン先ディレクトリ>
cd samples/BasicWebApp
cp .env.example .env

打开复制的.env文件，并设置以下部分。<client_id>和<client_secret>分别设置为在freee应用商店中注册应用程序时获取的值。

FREEE_ACCOUNTING_CLIENT_ID=<client_id>
FREEE_ACCOUNTING_CLIENT_SECRET=<client_secret>

在终端中执行以下操作。

# パッケージをインストールする
composer install

# Application encryption key を発行する
php artisan key:generate

# sqlite ファイルを作成し、マイグレーションを実行する
touch database/database.sqlite
php artisan migrate

# Laravel の内蔵サーバーを実行する
php artisan serve

# ※ Docker で動かしている場合は、下記のように host を指定する
php artisan serve --host 0.0.0.0

打开https://:8000，如果页面可以打开，则表示正常启动。

点击右上角的“LOGIN”，将对freee应用商店中的应用程序进行认证。第一次将显示“开始应用关联”的页面，请确认内容并点击“允许”按钮。

认证成功后，将重定向到https://:8000/home。如果上部栏中显示freee的用户名，则表示成功。此外，选择用户名，然后从下拉菜单中选择“Me”，如果显示用户信息和交易信息，则表示可以正确获取信息。

此外，要停止内置服务器，请按Ctrl + c。

Console的示例

Console的示例执行环境（Docker）

此外，为使用Docker的用户提供了包含上述执行环境的Dockerfile和docker-compose.yaml。使用时，请参考以下说明。

cd <本リポジトリのクローン先ディレクトリ>
cd samples
docker-compose build
docker-compose up -d
docker exec -it samples_console_1 /bin/bash

执行上述操作后，可以登录docker容器的/usr/src/app。此目录已挂载了本存储库的samples/BasicConsole。请适当修改以下说明以使用。

Console的示例执行步骤

在克隆此存储库后，使用PowerShell或bash等终端切换到目录中。

cd <本リポジトリのクローン先ディレクトリ>
cd samples/BasicConsole
cp .env.example .env

打开复制的.env文件，并设置以下部分。<client_id>和<client_secret>分别设置为在freee应用商店中注册应用程序时获取的值。

FREEE_ACCOUNTING_CLIENT_ID=<client_id>
FREEE_ACCOUNTING_CLIENT_SECRET=<client_secret>

在终端中执行以下操作。

# パッケージをインストールする
composer install

# php を interactive modeで実行する
php -a
php >require_once(__DIR__ . '/vendor/autoload.php');
php >$token = {対象のアクセストークン}
php >$cid = {対象の事業所ID}
php >$config = Freee\Accounting\Configuration::getDefaultConfiguration()->setAccessToken($token);
php >$partnersApiInstance = new Freee\Accounting\Api\PartnersApi(null, $config);
php >echo $partnersApiInstance->getPartners($cid);

SDK导入方法

在本节中，将记录使用Laravel利用此SDK的方法作为导入示例。

首先，创建一个新的Laravel项目。如果要在现有项目中导入，请跳过。首先，创建Laravel项目，请参考安装Laravel安装Laravel。另外，如果使用Dockerfile，则已经安装。

# Laravel のプロジェクトを新規作成し、そのディレクトリに移動する
laravel new sampleapp
cd sampleapp

# 確認のため、Laravel の内蔵サーバーを実行する
php artisan serve

# ※ Docker で動かしている場合は、下記のように host を指定する
php artisan serve --host 0.0.0.0

# 内蔵サーバーを停止するには、 Ctrl + c を押下します

.env 文件に以下を追加し、WebAppのサンプルの実行手順に従って<client_id>、<client-secret>を設定してください。

FREEE_ACCOUNTING_CLIENT_ID=<client_id>
FREEE_ACCOUNTING_CLIENT_SECRET=<client_secret>

次に、データベースの設定をsqliteに変更します。.envを以下のように編集します。DB_DATABASEはプロジェクト内のdatabase/database.sqliteへの絶対パスを設定します。適宜調整してください。

#DB_CONNECTION=mysql
DB_CONNECTION=sqlite
...
#DB_DATABASE=laravel
DB_DATABASE=/usr/src/app/database/database.sqlite

次に、sqliteファイルを作成し、マイグレーションを実行します。

# 自動作成されたマイグレーションファイルを削除する
rm database/migrations/2014_10_12_000000_create_users_table.php
# マイグレーションを作成する
php artisan make:migration create_users_table --create=users

作成したマイグレーションファイルを以下のように編集します。

        Schema::create('users', function (Blueprint $table) {
            $table->bigIncrements('id');
            // ↓↓ ここから ↓↓
            $table->unsignedBigInteger('freee_id')->unique();
            $table->string('name');
            $table->string('email')->unique();
            $table->timestamp('email_verified_at')->nullable();
            $table->string('first_name')->nullable();
            $table->string('last_name')->nullable();
            $table->string('token')->nullable();
            $table->rememberToken();
            // ↑↑ ここまで編集 ↑↑
            $table->timestamps();
        });
# sqlite ファイルを作成し、マイグレーションを実行する
touch database/database.sqlite
php artisan migrate

app/User.phpを編集します。

    protected $fillable = [
        // ↓↓ ここから ↓↓
        // 'name', 'email', 'password',
        'name', 'email', 'freee_id', 'first_name', 'last_name', 'token'
        // ↑↑ ここまで編集 ↑↑
    ];

プロジェクトの準備ができたら、パッケージのインストールを行います。本SDKのコアである会計freee APIはOAuth2による認証を行うため、Laravel公式パッケージであるSocialiteも利用します。

  • freee/freee-accounting-sdk：本SDK
  • socialiteproviders/generators：Socialiteのカスタムプロバイダのベースコードを生成するためのパッケージ（参考：https://github.com/SocialiteProviders/Generators）
  • socialiteproviders/manager：Socialiteのカスタムプロバイダを扱うためのパッケージ
composer require freee/freee-accounting-sdk
composer require socialiteproviders/generators
composer require socialiteproviders/manager

そしてconfig/app.phpのprovidersに、以下を参考にプロバイダを追加します。

    'providers' => [
        // ... 中略 ...
        SocialiteProviders\Generators\GeneratorsServiceProvider::class,
        SocialiteProviders\Manager\ServiceProvider::class,
        // ... 中略 ...
    ],

socialiteproviders/generatorsのArtisanコマンドを利用して、ベースコードを作成します。

# freee の OAuth2 認証を処理するコードを作成する
php artisan make:socialite FreeeAccounting --spec=oauth2 --authorize_url=https://accounts.secure.freee.co.jp/public_api/authorize --access_token_url=https://accounts.secure.freee.co.jp/public_api/token --user_details_url=https://api.freee.co.jp/api/1/users/me

# 作成したファイルを読み込む
composer dumpautoload

次に、認証用の画面を用意します。今回はlaravel/uiを導入し、その画面を流用します。詳細はAuthentication - Laravel - The PHP Framework For Web Artisansをご参照ください。

composer require laravel/ui
php artisan ui vue --auth
npm install && npm run dev

この時点で、routes/web.phpにはAuth::routes();が追加され、認証周りのルーティングが設定されています。今回は、新規登録とパスワードリセットを利用しないので、以下のように編集します。

// Auth::routes();
Auth::routes([
    'register' => false,
    'reset' => false,
]);

これまでの操作で、Laravelの内部でユーザーデータを持つ認証機構のベースができました。しかし、会計freee APIでは、freeeに認証・認可を問い合わせる構造になるため、さらに変更を加えます。

まず、routes/web.phpに以下のルーティングを追加します。

Route::get('login', 'Auth\LoginController@redirectToProvider')->name('login');
Route::get('auth-callback', 'Auth\LoginController@handleProviderCallback')->name('authCallback');

そして、設定値にも変更を加えます。まず、config/services.phpに以下を追加します。

<?php

return [

    // ... 中略 ...

    // ↓↓ ここから ↓↓
    'freeeaccounting' => [
        'client_id' => env('FREEE_ACCOUNTING_CLIENT_ID'),
        'client_secret' => env('FREEE_ACCOUNTING_CLIENT_SECRET'),
        'redirect' => 'https://:8000/auth-callback',
    ],
    // ↑↑ ここまで編集 ↑↑
];

次に、SocialiteProviders配下のコードを少し修正します。

SocialiteProviders/src/FreeeAccounting/Provider.php

    protected function getUserByToken($token)
    {
        // ... 中略 ...

        // ↓↓ ここから ↓↓
        // return json_decode($response->getBody(), true);
        $body = json_decode($response->getBody(), true);
        return $body['user'];
        // ↑↑ ここまで編集 ↑↑
    }
    protected function mapUserToObject(array $user)
    {
        // ↓↓ ここから ↓↓
        $user['name'] = $user['last_name'] . ' ' . $user['first_name'];
        // ↑↑ ここまで追加 ↑↑

        return (new User())->setRaw($user)->map([
            'id'       => $user['id'],
            // 'nickname' => $user['username'],
            'name'     => $user['name'],
            'email'    => $user['email'],
            // 'avatar'   => $user['avatar'],
            // ↓↓ ここから ↓↓
            'display_name' => $user['display_name'],
            'first_name' => $user['first_name'],
            'last_name' => $user['last_name'],
            'first_name_kana' => $user['first_name_kana'],
            'last_name_kana' => $user['last_name_kana'],
            // ↑↑ ここまで追加 ↑↑
        ]);
    }

それでは、次にコントローラを整備しましょう。まず、app\Http\Auth\LoginController.phpを編集し、会計freee APIにログインできるようにします。

<?php

namespace App\Http\Controllers\Auth;

use App\Http\Controllers\Controller;
// ↓↓ ここから ↓↓
// use Illuminate\Foundation\Auth\AuthenticatesUsers;
use Illuminate\Support\Facades\Auth;
use Laravel\Socialite\Facades\Socialite;
use App\User;
// ↑↑ ここまで編集 ↑↑

class LoginController extends Controller
{
    /*
    |--------------------------------------------------------------------------
    | Login Controller
    |--------------------------------------------------------------------------
    |
    | This controller handles authenticating users for the application and
    | redirecting them to your home screen. The controller uses a trait
    | to conveniently provide its functionality to your applications.
    |
    */

    // ↓↓ ここから ↓↓
    // use AuthenticatesUsers;
    // ↑↑ ここまで編集 ↑↑

    // ... 中略 ...

    // ↓↓ ここから ↓↓
    /**
     * Redirect the user to the Freee Accounting authentication page.
     *
     * @return \Illuminate\Http\Response
     */
    public function redirectToProvider()
    {
        return Socialite::driver('freeeaccounting')->redirect();
    }

    /**
     * Obtain the user information from Freee Accounting.
     *
     * @return \Illuminate\Http\Response
     */
    public function handleProviderCallback()
    {
        $user = Socialite::driver('freeeaccounting')->user();

        $loggedInUser = User::updateOrCreate(
            [
                'freee_id' => $user->id,
            ],
            [
                'name' => $user->name,
                'email' => $user->email,
                'first_name' => $user->first_name,
                'last_name' => $user->last_name,
                'token' => $user->token,
            ]
        );

        Auth::login($loggedInUser);
        return redirect($this->redirectTo);
    }

    public function logout()
    {
        Auth::logout();
        return redirect()->intended('/');
    }
    // ↑↑ ここまで追加 ↑↑
}

app/Providers/EventServiceProvider.phpも以下のように編集します。

<?php

namespace App\Providers;

// ... 中略 ...

// ↓↓ ここから ↓↓
use SocialiteProviders\Manager\SocialiteWasCalled;
use SocialiteProviders\FreeeAccounting\FreeeAccountingExtendSocialite;
// ↑↑ ここまで追加 ↑↑

class EventServiceProvider extends ServiceProvider
{
    /**
     * The event listener mappings for the application.
     *
     * @var array
     */
    protected $listen = [
        Registered::class => [
            SendEmailVerificationNotification::class,
        ],
        // ↓↓ ここから ↓↓
        SocialiteWasCalled::class => [
            FreeeAccountingExtendSocialite::class,
        ],
        // ↑↑ ここまで追加 ↑↑
    ];

    // ... 略 ...
}

これまでの手順により、Laravelプロジェクトで会計freee APIにログインできるようになりました。

次に、本SDKを利用して情報を取得する部分も作成してみましょう。

情報を表示するための、コントローラー、ビューを作成します。まず、コントローラとしてAccountControllerを作成しましょう。

php artisan make:controller AccountController

app/Http/Controllers/AccountController.phpが作成されるので、そこに処理を記述します。

<?php

namespace App\Http\Controllers;

// ↓↓ ここから ↓↓
// use Illuminate\Http\Request;
use Freee\Accounting\Configuration;
use Freee\Accounting\Api\CompaniesApi;
use Freee\Accounting\Api\DealsApi;
use Illuminate\Support\Facades\Auth;
// ↑↑ ここまで編集 ↑↑

class AccountController extends Controller
{
    //

    // ↓↓ ここから ↓↓
    /**
     * Create a new controller instance.
     *
     * @return void
     */
    public function __construct()
    {
        $this->middleware('auth');
    }

    /**
     * Display information of current user.
     *
     * @return \Illuminate\View\View
     */
    public function me()
    {
        $user = Auth::user();

        $config = Configuration::getDefaultConfiguration()->setAccessToken($user->token);

        $companiesApiInstance = new CompaniesApi(null, $config);
        $companiesResponse = $companiesApiInstance->getCompanies();

        $dealsApiInstance = new DealsApi(null, $config);
        $targetCompanyId = $companiesResponse->getCompanies()[0]->getId();
        $dealsNumberlimit = 5;
        $dealsResponse = $dealsApiInstance->getDeals(
            $targetCompanyId,
            null, null, null, null, null, null, null, null, null, null, null, null,
            $dealsNumberlimit);
        $deals = $dealsResponse->getDeals();

        $invoicesApiInstance = new InvoicesApi(null, $config);
        $invoicesResponse = $invoicesApiInstance->getInvoices($targetCompanyId);
        $invoices = $invoicesResponse->getInvoices();

        return view('account.me', compact('user', 'deals', 'invoices'));
    }
    // ↑↑ ここまで追加 ↑↑
}

そして、AccountControllerにルーティングを通すために、routes/web.phpで以下を追加します。

Route::get('/account/me', 'AccountController@me')->name('me');

次にビューを用意しましょう。resources/views/accountディレクトリを作成し、本リポジトリのsamples/BasicWebApp/resources/views/account配下のファイルをコピーします。

mkdir -p resources/views/account

# 前述のようにファイルをコピーする

作成したページへ遷移するメニューを追加しましょう。resources/views/layouts/app.blade.phpを以下のように更新します。

<!-- ... 中略 ... -->

<!-- Right Side Of Navbar -->
<ul class="navbar-nav ml-auto">
    <!-- Authentication Links -->
    @guest
        <li class="nav-item">
            <a class="nav-link" href="{{ route('login') }}">{{ __('Login') }}</a>
        </li>
        @if (Route::has('register'))
            <li class="nav-item">
                <a class="nav-link" href="{{ route('register') }}">{{ __('Register') }}</a>
            </li>
        @endif
    @else
        <li class="nav-item dropdown">
            <a id="navbarDropdown" class="nav-link dropdown-toggle" href="#" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false" v-pre>
                {{ Auth::user()->name }} <span class="caret"></span>
            </a>

            <div class="dropdown-menu dropdown-menu-right" aria-labelledby="navbarDropdown">
                <!-- ↓↓ ここから ↓↓ -->
                <a class="dropdown-item" href="{{ route('me') }}">
                    {{ __('Me') }}
                </a>
                <!-- ↑↑ ここまで追加 ↑↑ -->
                <a class="dropdown-item" href="{{ route('logout') }}"
                    onclick="event.preventDefault();
                                  document.getElementById('logout-form').submit();">
                    {{ __('Logout') }}
                </a>

<!-- ... 略 ... -->

ここで本手順は終わりです。サンプルの実行方法で示されるような動作が確認できれば導入成功です。

关于贡献

このプロジェクトへのコントリビューションを歓迎いたします。詳細についてはコントリビューションガイドをご覧ください。

许可证

ライセンスについては以下をご参照ください。

MIT License