form-synergy/php-api

用PHP编写的API客户端,用于管理Form Synergy服务。

1.6.0.1 2019-07-14 10:27 UTC

This package is auto-updated.

Last update: 2024-09-14 22:06:04 UTC


README

一个用于管理Form Synergy服务的PHP库。

使用composer安装

composer require form-synergy/php-api

包含库

require '/vendor/autoload.php';

启用会话管理

\FormSynergy\Session::enable();

导入Form Synergy类

use \FormSynergy\Fs as FS;

您需要在Form Synergy控制台中检索您的凭据。

Form Synergy网站: https://formsynergy.com/

  • $profileid = '';
  • $apikey = '';
  • $apisecret = '';

如果您是经销商

  • $resellerid = '';

配置

FS::Config([
    'version' => 'v1',
    'protocol' => 'https',
    'endpoint' => 'api.formsynergy.com',
    'apikey' => $apikey,
    'secretkey' => $secretkey,
    'max_auth_count' => 15,
]);

本地存储

启用本地存储以存储下载和响应。

FS::Storage( '/', 'local-storage' );

加载账户

加载并开始管理账户。

$api = FS::Api()->Load($profileid);

添加域名

$api->Create('website')
    ->Attributes([
        'name' => 'MyWebsite',
        'domain' => 'example.website.ltd',
        'proto' => 'https://'
    ])
    ->As('website');

元标签

按照以下方式添加网站ID元标签

<meta name="fs:siteid" content="<?php echo $api->_website('siteid');?>">

验证

$api->Get('website')
    ->Where([
        'siteid' => $api->_website('siteid')
    ])
    ->verify();

创建策略

策略由模块和目标组成。

$api->Create('strategy')
    ->Attributes([
        'name' => 'Default strategy',
        'siteid' => $api->_website('siteid')
    ])
    ->As('defaultStrategy');

创建模块

模块是由主题、正文和表单输入组成的捆绑包。每个模块都可以定制以单独处理事件和响应。模块可以链接在一起以创建连续的交互。 API文档

创建目标

目标允许您根据获得的信息定义通知方法和目标。 API文档