kevinbrk / shopify-api
Shopify API PHP 库
v5.1.0
2023-07-11 18:03 UTC
Requires
- php: ~8.0.0 || ~8.1.0 || ~8.2.0
- 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
- psr/log: ^1.1 || ^2.0 || ^3.0
- ramsey/uuid: ^4.1
Requires (Dev)
- 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
README
此库为 PHP Shopify 应用提供支持,通过简化以下操作,使其更容易访问 Shopify Admin API:
- 通过 OAuth 创建 Admin API 的在线或离线访问令牌
- 向REST API发送请求
- 向GraphQL API发送请求
- 注册/处理 Webhooks
除了 Admin API,此库还允许查询Storefront API。
此库可以用于任何具有 PHP 后端的任何应用程序,因为它不依赖于任何特定框架——您可以在您的首选堆栈中包含它,并且仅使用构建应用程序所需的特性。
要求
要遵循这些使用指南,您需要
- 具备基本的PHP理解
- 拥有 Shopify 合作伙伴账户和开发商店
- 或者在可以创建私有应用的测试商店中
- 在测试商店或合作伙伴账户中已设置私有或自定义应用
- 使用ngrok,以便创建到运行在本地主机的应用的加密隧道
- 将
ngrokURL 和您的 OAuth 回调路由的适当重定向添加到您的应用设置中
入门
您可以遵循我们的入门指南,了解如何使用此库的组件。
开发此库
在克隆仓库后,Composer 可以安装依赖项
composer install
运行测试
composer test
如果您想从测试中获得代码覆盖率报告,您需要通过运行 pecl install xdebug 安装 php-xdebug 扩展,然后运行
composer test -- [--coverage-text|--coverage-html=<path>]
当命名空间更改时,您可能需要清除 Composer 的自动加载缓存
composer dump-autoload
运行代码检查器
composer lint