Download the PHP package nonz250/smaregi-api-php without Composer
On this page you can find all versions of the php package nonz250/smaregi-api-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package smaregi-api-php
smaregi-api-php
- PSR-7: HTTP message interfaces - PHP-FIG
- PSR-17: HTTP Factories - PHP-FIG
- PSR-18: HTTP Client - PHP-FIG
上記 PSR にて決められたインターフェースで実装したスマレジ・プラットフォーム API クライアントライブラリです。
Installation
Usage
- 仕様書 | ドキュメント | スマレジ・デベロッパーズ
- スマレジ・プラットフォームAPI 共通仕様書
- スマレジ・プラットフォームAPI POS仕様書
- スマレジ・プラットフォームAPI 受注管理 仕様書
- スマレジ・プラットフォームAPI Waiter 仕様書
- スマレジ・プラットフォームAPI Timecard仕様書
アプリアクセストークン取得
https://github.com/nonz250/smaregi-api-php/blob/main/sample/public/application_token.php
getAccessToken の引数に new SmaregiClientCredentials() を渡し、 options に contract_id を指定してください。
また、その際に必要に応じて scope を指定してください。
ユーザーアクセストークン取得
https://github.com/nonz250/smaregi-api-php/blob/main/sample/public/auth.php
必要に応じて redirect_uri を指定してください。
同様に getAuthorizationUrl 呼び出し時に scope に必要なものを指定してください。
セキュリティ対策のため、 state と pkce を保持し、 redirect_uri の先でチェック処理をしてください。
https://github.com/nonz250/smaregi-api-php/blob/main/sample/public/callback.php
セキュリティ対策のため、保持していた state と pkce のチェック処理をしてください。
Sample
https://github.com/nonz250/smaregi-api-php/tree/main/sample
上記を実行後、 http://localhost へアクセスし、このライブラリを利用した際の実際の動作を確認することができます。
このとき、 スマレジ・デベロッパーズ で取得できるクレデンシャル情報が必要なので、予めスマレジ・デベロッパーズアカウントを取得してください。
https://developers.smaregi.jp/signup/
スマレジ・デベロッパーズのアカウント登録ができたら新規にアプリを追加し、必要なクレデンシャル情報を取得してください。
※この際、パブリックアプリかプライベートアプリかは問いません。
| 変数名 | 内容 |
|---|---|
| SMAREGI_IDP_HOST | スマレジIdPサーバーのホスト。デフォルトはサンドボックス環境のホスト。 |
| SMAREGI_CONTRACT_ID | 対象の契約ID |
| SMAREGI_CLIENT_ID | 対象のクライアントID |
| SMAREGI_CLIENT_SECRET | 対象のクライアントシークレット |
.env.example を .env へコピーし上記のパラメーターに対応するよう、それぞれ適切な値を設定してください。
https://github.com/nonz250/smaregi-api-php/tree/main/sample/public/.env.example
Contributing
このリポジトリは Docker の利用を推奨しています。
詳細は Makefile を参照してください。
Help
各コマンドのヘルプが表示されます。
Build
Docker における開発環境をビルドします。
Please execute before make Pull Request.
Pull Request を作成する前には make pr を実行してください。
- formatter ( PHP CS Fixer )
- static analyzer ( PHPStan )
- unit test ( PHPUnit )
が実行されます。
All versions of smaregi-api-php with dependencies
fig/http-message-util Version ^1.1
psr/http-client Version ^1.0
psr/http-factory Version ^1.0
psr/http-message Version ^2.0
league/oauth2-client Version ^2.7