README

Vivus Hub 应用程序系列旨在帮助用户创建和分享现场体验。本仓库已经尽可能详细地记录，以帮助组织者和开发者获得最佳平台体验。如需进一步帮助，请通过电子邮件联系 support@vivushub.com。

特性
使用指南
获取密钥
创建活动
活动列表
获取洞察
处理门票
处理推广者
安装
端点参考
致谢
许可证

使用指南

Graph API 是基于 HTTP 的，因此它可以与任何具有 HTTP 库（如 cURL 等）的语言一起工作。额外的优点是您可以直接在浏览器中使用 Graph API 库。

获取密钥

本文档假设您已经拥有 API 访问令牌或密钥。如果您没有，请登录到 Vivus。您可以在设置下找到您的令牌。

创建活动

Vivus Hub 在创建和更新活动方面提供了高度的灵活性。要更新、创建或修改活动，您需要以下参数

eventname [String] - 您活动的名称。
organiser [String] - 组织者的名称。
img [String] - 活动图片的 URL。
tag [String] - 活动的简短推广标签。
desc [String] - 活动的描述。
startdate [datetime] - 活动开始时间，通常为 dd-mm-YYY HH:mm:ss 24 小时格式。
enddate [datetime] - 活动结束时间，通常为 dd-mm-YYY HH:mm:ss 24 小时格式。
location [String] - 活动地点，简短但描述性，例如 1600 Pennsylvania Avenue NW Washington, D.C.
country [String] - 活动举办的国家。
rType [String] - 请求类型，此变量仅接受 delete、update、create。
key [String] - 您的公共 API 密钥。

当修改活动时，您可以自由忽略希望保持不变的变量。一旦发起请求，就会返回 JSON 数据，例如

// Endpoint Request
curl -i -X GET \
"https://www.api.vivushub.com/event"

// Response 
{
    'status': 'Success', // Other response include fail
    'id': 'event-id'
}

活动列表

要获取您在 Vivus Create 上托管的活动的列表，您需要以下参数

id [String] - 更新或删除活动时的活动 ID。
username [String] - 您的用户名。
pgn [String] - 通过此数字偏移返回的事件列表。
rType [String] - 请求类型，此变量仅接受 delete、update、create。
key [String] - 您的公共 API 密钥。

// Endpoint Request
curl -i -X GET \
"https://www.api.vivushub.com/list"

// Response 
{
    'status': 'success',
    'result': [
        {
            'id': '',
            'username': '',
            'eventname': '',
            'organiser': '',
            'location': '',
            'Country': '',
            'iso': '',
            'startdate': '',
            'enddate': '',
            'rType': ''
        }
    ]
}

出于安全原因，门票创建、更新和删除需要不同的端点。

获取洞察

// Endpoint Request
curl -i -X GET \
"https://www.api.vivushub.com/insight"

// Response

处理门票

// Endpoint Request
curl -i -X POST \
"https://www.api.vivushub.com/ticket"

// Response

处理推广者

推广者可以帮助您触达更广泛的受众，我们理解并已在Vivus中利用了这一点。要处理推广者，您需要以下参数：

id [String] - 您要更新的推广者的ID。
username [String] - 推广者的用户名。
eventid [String] - 活动ID，您可以从活动列表中找到它。
amount [String] - 您愿意支付给推广者的金额。请注意，支付基于举办活动的货币，例如，如果票价以英镑计价，推广者将以英镑支付。
rType [String] - 请求类型，此变量仅接受 delete、update、create、list。

// Endpoint Request
curl -i -X POST \
"https://www.api.vivushub.com/partners"

// Create, Update, Delete
{
    'status': 'success',
    'promoter': 'username',
    'id': 'id'
}

// Listing
{
    'result': [
        {
            'id': '',
            'promoter': '',
            'amount': '',
            'timeRegistered': ''
        }
    ]
}

安装

PHP安装

Vivus Hub SDK使用composer来管理依赖。请访问composer文档了解如何安装composer。

将以下内容添加到您的composer.json文件中

{
    "require": {
        "vivus-hub/php-sdk"
    }
}

然后通过composer进行安装

php composer.phar install --no-dev

此SDK及其依赖项将安装在./vendor下。

端点参考

处理活动

// Endpoint Request
curl -i -X GET \
"https://www.api.vivushub.com/event"

显示托管活动

// Endpoint Request
curl -i -X GET \
"https://www.api.vivushub.com/list"

处理洞察

// Endpoint Request
curl -i -X GET \
"https://www.api.vivushub.com/insight"

处理门票

// Endpoint Request
curl -i -X POST \
"https://www.api.vivushub.com/ticket"

合作伙伴

// Endpoint Request
curl -i -X POST \
"https://www.api.vivushub.com/partners"

版权

Vivus Hub API由Vivus Hub Ltd拥有和维护。您可以在Twitter上关注我们VivusHub。

许可

此文档中的代码和所有相关文本均属于Vivus Hub商业内容。

vivus-hub / php-sdk

维护者

详细信息

README

使用指南

获取密钥

创建活动

活动列表

获取洞察

处理门票

处理推广者

安装

PHP安装

端点参考

版权

许可