shopify / shopify-api
PHP Shopify API 库
v5.6.0
2024-07-02 17:53 UTC
Requires
- php: ^8.1
- ext-ctype: *
- ext-hash: *
- ext-json: *
- ext-mbstring: *
- doctrine/inflector: ^2.0
- firebase/php-jwt: ^5.2 || ^6.2
- guzzlehttp/guzzle: ^7.0
- guzzlehttp/psr7: ^2.0
- psr/http-client: ^1.0
- psr/http-message: ^1.0 || ^2.0
- psr/log: ^1.1 || ^2.0 || ^3.0
- ramsey/uuid: ^4.1
Requires (Dev)
- ext-apcu: *
- ergebnis/composer-normalize: ^2.30
- maglnet/composer-require-checker: ^3.0 || ^4.0
- mikey179/vfsstream: ^1.6
- phpunit/phpunit: ^9
- squizlabs/php_codesniffer: ^3.6
Suggests
- ext-apcu: Log fewer API deprecation warnings
README
此库为PHP Shopify 应用程序提供支持,以便通过OAuth更轻松地访问 Shopify Admin API,执行以下操作:
- 创建 在线 或 离线 访问令牌
- 向 REST API 发送请求
- 向 GraphQL API 发送请求
- 注册/处理webhooks
除了Admin API之外,此库还允许查询 Storefront API。
此库可以用于任何具有PHP后端的应用程序,因为它不依赖于任何特定框架——您可以在您的首选堆栈中包含它,并且只使用您构建应用程序所需的功能。
要求
要遵循这些使用指南,您需要
- 了解基本的 PHP 知识
- 拥有Shopify合作伙伴账户和开发商店
- 或 在可以创建私有应用程序的测试商店中
- 在测试商店或合作伙伴账户中已经设置了一个私有或自定义应用程序
- 使用 ngrok,以创建到您本地主机上运行的应用程序的安全隧道
- 将
ngrok
URL 和适当的OAuth回调路由重定向添加到应用程序设置中
入门
您可以按照我们的 入门指南 学习如何使用此库的组件。
开发此库
在克隆存储库之后,Composer可以安装依赖项
composer install
运行测试
composer test
如果您想从测试中获得代码覆盖率报告,您需要通过运行 pecl install xdebug
安装 php-xdebug
扩展,然后运行
composer test -- [--coverage-text|--coverage-html=<path>]
当命名空间更改时,可能需要清除Composer的autoload缓存
composer dump-autoload
运行linter
composer lint
在修改了 composer.json
文件之后,请确保运行
composer validate
composer normalize