15web/sailplay-sdk

SailPlay HTTP API的PHP SDK (https://sailplay.ru/)

dev-main 2022-08-25 09:58 UTC

This package is auto-updated.

Last update: 2024-09-25 14:16:03 UTC


README

PHP语言编写的SailPlay营销自动化平台SDK — https://sailplay.ru.

将加速SailPlay功能集成到您的产品中。

  • 无需关注请求细节(如url格式、headers、query string等)。
  • 所有请求和响应都是通过类型化类实现的。
  • 创建和使用类时,IDE将提供代码提示。
  • 支持类型检查和输入参数验证。
  • 提供日志记录功能,用于调试和错误处理。无需编写代码来检查响应体。
  • 内置token缓存功能,这是SailPlay推荐用于API的。

安装

composer require 15web/sailplay-sdk

使用

<?php

require_once 'vendor/autoload.php';

try {
    // отправляем запрос на получение токена
    $loginResponse = \Studio15\SailPlay\SDK\SailPlayApi::login(
        $storeDepartmentId = 12345,
        $storeDepartmentKey = 12345678,
        $pinCode = 1234
    );
// при наличии в ответе ошибки будет выброшено соответствующее исключение
} catch (\Studio15\SailPlay\SDK\Api\Login\AuthErrorException $authErrorException) {
    echo "Ошибка аутентификации: {$authErrorException->getMessage()}";
}

// ответ - это объект с геттерами доступных полей
$token = $loginResponse->getToken();

// отправляем запрос на получение информации о клиенте
$userInfoResponse = \Studio15\SailPlay\SDK\SailPlayApi::usersInfo(
    $token,
    $storeDepartmentId = 12345,
    $userPhone = '79991234567'
);

echo $userInfoResponse->getEmail();

开发

构建PHP镜像(运行run.bash之前必须执行此操作)

./bin/docker_build.bash

安装依赖

./bin/run.bash composer install

运行PHP

./bin/run.bash php tests/functional/Users/info.php

功能测试

cp tests/functional/.env.dist tests/functional/.env
./bin/run.bash php tests/functional/Users/info.php

安装git钩子

./bin/hooks.bash

版权和许可

版权 © Studio 15, 2012 - 现在。
代码在MIT许可证下发布。

我们使用BrowserStack进行跨浏览器测试。

BrowserStack

❤️