qualityunit/crm-client

此页面包含CRM软件的完整API文档。

维护者

详细信息

github.com/QualityUnit/Crm-Api-Php-client

主页

源代码

问题

安装: 385

依赖项: 0

建议者: 0

安全: 0

星标: 0

关注者: 8

分支: 0

开放问题: 0

1.35.0 2023-12-08 15:52 UTC

Requires

Requires (Dev)

unlicense 705f03f6af7e31f8fb9f331b0441e673d901da7f

phprestapisdkopenapiopenapitoolsopenapi-generator

This package is auto-updated.

Last update: 2023-12-08 16:14:34 UTC

README

此页面包含CRM软件的完整API文档。

安装与使用

要求

PHP 8.1及更高版本。

Composer

要通过Composer安装绑定，请在composer.json中添加以下内容

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/QualityUnit/Crm-Api-Php-client.git"
    }
  ],
  "require": {
    "QualityUnit/Crm-Api-Php-client": "*@dev"
  }
}

然后运行composer install

手动安装

下载文件并包含autoload.php

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

入门

请按照安装程序进行操作，然后运行以下命令

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure OAuth2 access token for authorization: privileges
$config = Qu\CrmClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure API key authorization: api_key
$config = Qu\CrmClient\Configuration::getDefaultConfiguration()->setApiKey('apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Qu\CrmClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apikey', 'Bearer');


$apiInstance = new Qu\CrmClient\Api\AdminPanelApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->getSubscriptionSources();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdminPanelApi->getSubscriptionSources: ', $e->getMessage(), PHP_EOL;
}

API端点

所有URI均相对于 https://crm.qualityunit.com/api/v3

类 方法 HTTP请求 描述
AdminPanelApi getSubscriptionSources GET /admin_panel/sources 订阅源列表
AdminPanelApi getSubscriptionView GET /admin_panel/subscription_view/{subscriptionId} 订阅视图数据
AttributesApi getAttribute GET /attributes/{attributeId} 属性
AttributesApi getAttributes GET /attributes 属性列表
AttributesApi setAttribute PUT /attributes/{attributeId} 属性
BillingApi checkVat POST /billing/_check_vat 增值税有效性
CountriesApi getCountries GET /countries 国家列表
CouponApi getCoupon GET /coupons/{couponCode} 优惠券
CouponsApi extendCouponValidity POST /coupons/{couponCode}/_extend_validity 延长优惠券有效期
DevApi devCreateSubscription POST /dev/_create_subscription 创建开发订阅
EventLogsApi getEventLogs GET /event_logs 事件日志列表
HackApi hackDummyPaymentMethod POST /_hack/_dummy_payment_method 设置虚拟支付方式
InternalApi accountUserLogin GET /subscriptions/{subscriptionId}/_login 以账户用户身份登录
InternalApi cancelDiscount DELETE /discounts/{discountId} 取消折扣
InternalApi createAddon POST /addons 创建新插件
InternalApi createCoupon POST /coupons 创建优惠券
InternalApi createDiscount POST /discounts 创建折扣
InternalApi customResellerUrl GET /subscriptions/{subscriptionId}/upgrade_url 定制分销商升级URL
InternalApi deleteAddon DELETE /addons/{codename} 插件
InternalApi elasticReindex POST /subscriptions/{subscriptionId}/elastic_reindex 重新索引订阅LA数据
InternalApi elasticReindexStatus GET /subscriptions/{subscriptionId}/elastic_status LA弹性重索引状态
InternalApi generateForAgents POST /my-account/{subscriptionId}/_authorize '我的账户'令牌
InternalApi getAccountUsers GET /subscriptions/{subscriptionId}/account_users 账户用户
InternalApi getAddon GET /addons/{codename} 插件
InternalApi getAddons GET /addons 插件列表
InternalApi getCoupons GET /coupons 优惠券列表
InternalApi getDiscount GET /discounts/{discountId} 折扣
InternalApi getDiscounts GET /discounts 折扣列表
InternalApi getOutboxEmail GET /outbox/{emailId} 电子邮件
InternalApi getOutboxEmails GET /outbox 电子邮件列表
InternalApi getSubscriptionStatusHistory GET /subscriptions/{subscriptionId}/status_history 状态历史
InternalApi updateAddon PUT /addons/{codename} 插件
InvoicesApi downloadInvoice GET /invoices/{invoiceNumber}/_download 下载发票
InvoicesApi getInvoice GET /invoices/{invoiceNumber} 发票
InvoicesApi getInvoices GET /invoices 发票列表
InvoicesApi refundInvoice POST /invoices/{invoiceNumber}/_refund 退款发票
InvoicesApi regenerateInvoice POST /invoices/{invoiceNumber}/_regenerate_pdf 重新生成发票PDF
LakbdomainApi checkCertificate PUT /lakbdomain/_check_certificate 证书检查
LiveagentApi setKnowledgebases POST /subscriptions/{subscriptionId}/liveagent/knowledgebases 设置知识库设置
MassActionsApi massDelete POST /subscriptions/massAction/_delete 删除多个订阅
MassActionsApi massSuspend POST /subscriptions/massAction/_suspend 暂停多个订阅
MassActionsApi massTerminate POST /subscriptions/massAction/_terminate 终止多个订阅
MassActionsApi massUpdate POST /subscriptions/massAction/_update 更新多个订阅
MinionsApi addNewMinion POST /minions 添加新分矿
MinionsApi deleteMinion DELETE /minions/{minionId} 删除分矿
MinionsApi editMinion PUT /minions/{minionId} 编辑分矿
MinionsApi getMinion GET /minions/{minionId} 分矿
MinionsApi getMinionClusterNames GET /minions/options/clusterNames 分矿集群名称列表
MinionsApi getMinionRoles GET /minions/options/roles 分矿角色列表
MinionsApi getMinions GET /minions 分矿列表
MinionsApi reSyncMinion POST /minions/{minionId}/_reSync 重新同步分矿并设置
MinionsApi setMinionDown POST /minions/{minionId}/_setDown 设置分矿为下线
MinionsApi setMinionUp POST /minions/{minionId}/_setUp 设置分矿为上线
MyAccountApi cancelStop POST /my-account/_cancelStop 重新启动计费
MyAccountApi changeAddonsForMyAccount PUT /my-account/addons 插件更改
MyAccountApi downloadInvoiceForMyAccount GET /my-account/invoices/{invoiceNumber}/_download 下载发票
MyAccountApi 下载摘要 GET /my-account/summary/{orderNumber}/_download 下载摘要
MyAccountApi generate POST /checkout/_authorize '我的账户'令牌
MyAccountApi getAccountInvoices GET /my-account/invoices 发票列表
MyAccountApi getAccountSummaries GET /my-account/summary/history 摘要列表
MyAccountApi getActiveAddonsForMyAccount GET /my-account/addons 计划插件列表
MyAccountApi getAgentsCount GET /my-account/usage/agents/count 代理数量
MyAccountApi getAllVariationAddonsForMyAccount GET /my-account/variations/{variationId}/addons 变体插件
MyAccountApi getBillingInfoForMyAccount GET /my-account/billingInfo 账单信息
MyAccountApi getBillingStatusForMyAccount GET /my-account/billingStatus 账单状态
MyAccountApi getCouponForMyAccount GET /my-account/coupons/{couponCode} 优惠券
MyAccountApi getKnowledgebasesCount GET /my-account/usage/knowledgebases/count 知识库数量
MyAccountApi getPaymentMethodForMyAccount GET /my-account/paymentMethod 获取支付方式
MyAccountApi getPaymentProcessorForMyAccount GET /my-account/paymentProcessor 支付处理器
MyAccountApi getSubscriptionForMyAccount GET /my-account/subscription 订阅
MyAccountApi getSummaryForMyAccount GET /my-account/summary 当前周期摘要
MyAccountApi getUpgradeVariationsForMyAccount GET /my-account/upgradeVariations 升级变体列表
MyAccountApi getVariationForMyAccount GET /my-account/variation 变体
MyAccountApi 参数 GET /my-account/parameters “我的账户”参数
MyAccountApi predictPrice POST /my-account/_predictPrice 返回商品列表和预测价格
MyAccountApi sendPaymentError POST /my-account/sendPaymentError 将支付错误发送到服务器
MyAccountApi stopAccount POST /my-account/_stop 停止计费
MyAccountApi updateBillingInfo PUT /my-account/billingInfo 账单信息
MyAccountApi updatePaymentMethod PUT /my-account/paymentMethod 更新支付方式
MyAccountApi upgradePlan POST /my-account/_upgrade 更改计划
MyAccountApi validateBillingInfoForMyAccount POST /my-account/_validateBillingInfo 测试计费信息
ProductsApi createProductVersion POST /products/{productId}/versions 创建新的产品版本
ProductsApi deleteProductVersion DELETE /products/{productId}/versions/{productVersionName} 删除产品版本
ProductsApi getAllProductAvailableVersions GET /products/{productId}/available_versions 产品可用版本
ProductsApi getProduct GET /products/{productId} 产品
ProductsApi getProductVersion GET /products/{productId}/versions/{productVersionName} 产品版本
ProductsApi getProductVersions GET /products/{productId}/versions 产品版本
ProductsApi getProducts GET /products 产品列表
ProductsApi markProductVersionForDeletion PUT /products/{productId}/versions/{productVersionName}/mark_for_deletion 标记产品版本为删除
ProductsApi updateProductVersion PUT /products/{productId}/versions/{productVersionName} 更新产品版本
RedeemCodesApi createRedeemCode POST /redeem_codes 创建兑换码
RedeemCodesApi deleteRedeemCode DELETE /redeem_codes/{redeemCode} 删除兑换码
RedeemCodesApi getRedeemCode GET /redeem_codes/{redeemCode} 兑换码
RedeemCodesApi getRedeemCodes GET /redeem_codes 兑换码列表
RedeemCodesApi redeemCodeSignup POST /redeem_code/signup 创建订阅
RedeemCodesApi redeemCodesImport POST /redeem_codes/import 导入兑换码
RefundsApi getRefund GET /refunds/{refundId} 退款
RefundsApi getRefunds GET /refunds 退款列表
ResellerApi getResellerBilledPeriods GET /reseller/subscriptions/{subscriptionId}/billed_periods 经销商订阅计费周期列表
ResellerApi getResellerInvoices GET /reseller/invoices 经销商发票列表
ResellerApi getResellerSubscription GET /reseller/subscriptions/{subscriptionId} 获取经销商订阅
ResellerApi getResellerSubscriptionUsage GET /reseller/subscriptions/{subscriptionId}/usage/agents 获取经销商订阅使用情况
ResellerApi getResellerSubscriptions GET /reseller/subscriptions 获取经销商订阅
ResellerApi resellerChangePlan POST /reseller/subscriptions/{subscriptionId}/_upgrade 更改计划
ResellerApi resellerSignup POST /reseller/subscriptions 创建经销商订阅
ResellerApi suspendResellerSubscription POST /reseller/subscriptions/{subscriptionId}/_suspend 暂停经销商订阅
ResellerApi unsuspendResellerSubscription POST /reseller/subscriptions/{subscriptionId}/_unsuspend 恢复经销商订阅
SettingsApi getSettings GET /settings 设置列表
SettingsApi updateSettingGroup PUT /settings 更新设置组
StatsApi getAccountStats GET /stats/account 账户统计
StatsApi getAgentsStats GET /stats/agents 10个或更多代理的账户统计
StatsApi getSaleStats GET /stats/sale 销售统计
StatsApi 获取版本统计 GET /stats/versions 版本统计
SubscriptionsApi 添加免费插件 POST /subscriptions/{subscriptionId}/_addFreeAddons 添加免费插件
SubscriptionsApi 账户管理员 PUT /subscriptions/{subscriptionId}/account_manager 分配账户管理员
SubscriptionsApi 同意请求账单 POST /subscriptions/{subscriptionId}/pap_request_billing PAP 同意额外账单
SubscriptionsApi 更改插件 PUT /subscriptions/{subscriptionId}/addons 插件更改
SubscriptionsApi 更改计划 POST /subscriptions/{subscriptionId}/_upgrade 更改计划
SubscriptionsApi 检查域名 POST /subscriptions/_check_domain 域名可用性
SubscriptionsApi 清除上次支付失败 POST /subscriptions/{subscriptionId}/_clearLastPaymentFail 清除上次支付失败
SubscriptionsApi 删除 POST /subscriptions/{subscriptionId}/_delete 删除订阅
SubscriptionsApi 延长有效期 POST /subscriptions/{subscriptionId}/_extendValidity 延长账户有效期
SubscriptionsApi 获取账户 GET /accounts/{accountId} 账户
SubscriptionsApi 获取账户管理员 GET /subscriptions/{subscriptionId}/account_manager 获取账户管理员
SubscriptionsApi 获取活动插件 GET /subscriptions/{subscriptionId}/addons 插件列表
SubscriptionsApi 获取账单信息 GET /subscriptions/{subscriptionId}/billingInfo 账单信息
SubscriptionsApi 获取账单指标 GET /subscriptions/{subscriptionId}/billingMetrics 账单指标
SubscriptionsApi 获取账单状态 GET /subscriptions/{subscriptionId}/billingStatus 账单状态
SubscriptionsApi 获取域名信息 GET /subscriptions/{subscriptionId}/domain 域名信息
SubscriptionsApi 获取失败支付 GET /failed_payments/{failedPaymentId} 失败支付
SubscriptionsApi 获取失败支付 GET /failed_payments 失败支付列表
SubscriptionsApi 获取安装进度 GET /subscriptions/{subscriptionId}/install_progress 安装进度
SubscriptionsApi 获取备注 GET /subscriptions/{subscriptionId}/note 备注
SubscriptionsApi 获取支付方式 GET /subscriptions/{subscriptionId}/paymentMethod 支付方式
SubscriptionsApi 获取支付处理器 GET /subscriptions/{subscriptionId}/paymentProcessor 支付处理器
SubscriptionsApi 获取来源 GET /subscriptions/{subscriptionId}/source 安装来源
SubscriptionsApi 获取订阅 GET /subscriptions/{subscriptionId} 订阅
SubscriptionsApi 获取订阅属性 GET /subscriptions/{subscriptionId}/attributes 订阅属性列表
SubscriptionsApi 获取订阅折扣 GET /subscriptions/{subscriptionId}/discounts 订阅折扣
SubscriptionsApi 获取订阅发票 GET /subscriptions/{subscriptionId}/invoices 订阅发票列表
SubscriptionsApi 获取订阅 GET /subscriptions 订阅列表
SubscriptionsApi 获取升级变体 GET /subscriptions/{subscriptionId}/upgradeVariations 升级变体列表
SubscriptionsApi 是否同意额外账单 GET /subscriptions/{subscriptionId}/pap_request_billing PAP 获取额外账单
SubscriptionsApi 刷新账户 POST /subscriptions/{subscriptionId}/_refreshAccount 刷新账户
SubscriptionsApi 移除锁定 PUT /subscriptions/{subscriptionId}/unlock 移除锁定
SubscriptionsApi 请求操作 POST /subscriptions/{subscriptionId}/_requestAction 请求账单操作
SubscriptionsApi 恢复账单 POST /subscriptions/{subscriptionId}/_cancelStop 重新启动计费
SubscriptionsApi 设置账单信息 PUT /subscriptions/{subscriptionId}/billingInfo 账单信息
SubscriptionsApi 设置自定义域名 PUT /subscriptions/{subscriptionId}/custom_domain 自定义域名
SubscriptionsApi 设置默认域名 PUT /subscriptions/{subscriptionId}/default_domain 默认域名
SubscriptionsApi 设置域名 PUT /subscriptions/{subscriptionId}/domain 自定义域名
SubscriptionsApi 设置锁定 PUT /subscriptions/{subscriptionId}/lock 设置订阅锁定
SubscriptionsApi 设置备注 PUT /subscriptions/{subscriptionId}/note 备注
SubscriptionsApi 设置所有者邮箱 PUT /subscriptions/{subscriptionId}/owner_email 所有者邮箱
SubscriptionsApi 设置 PAP 跟踪参数 PUT /subscriptions/{subscriptionId}/pap_tracking_params PAP 跟踪参数
SubscriptionsApi 设置支付方式 PUT /subscriptions/{subscriptionId}/paymentMethod 支付方式
SubscriptionsApi 设置来源 PUT /subscriptions/{subscriptionId}/source 安装来源
SubscriptionsApi 设置订阅使用情况 PUT /subscriptions/{subscriptionId}/usage 订阅使用情况
SubscriptionsApi 设置更新策略 PUT /subscriptions/{subscriptionId}/update_policy 设置更新策略
SubscriptionsApi 注册 POST /subscriptions 创建订阅
SubscriptionsApi 停止计费 POST /subscriptions/{subscriptionId}/_stop 停止计费
SubscriptionsApi 暂停 POST /subscriptions/{subscriptionId}/_suspend 暂停订阅
SubscriptionsApi 切换变体 POST /subscriptions/{subscriptionId}/_switchVariation 切换订阅的变体
SubscriptionsApi 终止 POST /subscriptions/{subscriptionId}/_terminate 终止订阅
SubscriptionsApi 取消暂停 POST /subscriptions/{subscriptionId}/_unsuspend 取消暂停订阅
SubscriptionsApi 更新应用程序 POST /subscriptions/{subscriptionId}/_update 更新订阅
SubscriptionsApi 验证计费信息 POST /subscriptions/{subscriptionId}/_validateBillingInfo 测试计费信息
TasksApi 获取丰富任务 GET /executor/tasks/{taskId} 任务
TasksApi 获取丰富任务尝试 GET /executor/task_attempts/{taskAttemptId} 任务尝试
TasksApi 获取任务操作 GET /executor/actions/{actionId} 操作
TasksApi 获取任务子节点作业 GET /executor/actions/{actionId}/minion_jobs/{minionId} 子节点作业
TasksApi 获取任务列表 GET /executor/tasks 任务列表
TasksApi 标记任务损坏 POST /executor/tasks/{taskId}/_mark_broken 标记任务损坏
TasksApi 重试任务尝试 POST /executor/tasks/{taskId}/_retry 重试任务尝试
TemplatesApi 获取模板 GET /templates/{templateId} 模板
TemplatesApi 获取模板列表 GET /templates 模板列表
TemplatesApi 更新模板 PUT /templates/{templateId} 模板
TokenApi 获取访问令牌 POST /token 访问令牌
VariationsApi 编辑附加组件 POST /variations/{variationId}/addons/{codename}/_change_state 更改附加组件的状态
VariationsApi 获取所有变体附加组件 GET /variations/{variationId}/addons 变体插件
VariationsApi 获取变体 GET /variations/{variationId} 变体
VariationsApi 获取变体附加组件 GET /variations/{variationId}/available_addons 变体插件
VariationsApi 获取变体 GET /variations 变体列表
VariationsApi 更新变体 PUT /variations/{variationId} 变体

模型

授权

权限

  • 类型: OAuth
  • 流程: accessCode
  • 授权URL: ``
  • 作用域:
    • hack.dummy_payment: 设置模拟支付
    • account.switch_variation: 切换变体
    • agent.login: 登录账户
    • attribute.read: 读取属性
    • attribute.write: 更改属性
    • dev.create_subscription: 创建开发者订阅
    • event_logs.read: 读取事件日志
    • invoice.read: 读取发票
    • job.read: 读取工作
    • product.read: 读取产品
    • product.write: 更改产品
    • refund.read: 读取退款
    • refund.write: 更改退款
    • reseller.own: 读取有关调用零售商的信息
    • reseller.signup: 创建新的零售商订阅
    • reseller.read: 读取有关零售商的信息
    • reseller.write: 管理零售商或零售商订阅
    • subscription.own: 读取/写入自己的订阅（使用'me'作为subscriptionId）
    • subscription.read: 读取订阅
    • subscription.basicOperations: 代理商允许的订阅操作
    • subscription.write: 写入订阅
    • subscription.delete: 删除订阅
    • subscription.reindex: 账户重新索引
    • subscription.massActions: 订阅大量操作
    • subscription.changeDomain: 更改默认或自定义域名
    • subscription.changeDefaultDomain: 更改默认域名
    • subscription.changeCustomDomain: 更改自定义域名
    • task.read: 读取任务
    • task.write: 写入任务
    • template.read: 读取模板
    • template.write: 更改模板
    • variation.read: 读取变体
    • variation.write: 更改变体
    • minion.read: 读取小兵
    • minion.write: 写入小兵
    • stats.sale: 销售统计
    • stats.account: 账户数量统计
    • settings.read: 读取设置
    • settings.write: 更改设置
    • stats.versions: 获取统计版本
    • stats.agents: 获取统计代理商
    • addon.read: 读取插件
    • addon.write: 修改插件

api_key

  • 类型: API密钥
  • API密钥参数名称: apikey
  • 位置: HTTP头

测试

要运行测试，请使用

composer install
vendor/bin/phpunit

作者

support@qualityunit.com

关于此包

此PHP包是由OpenAPI Generator项目自动生成的

  • API版本: 3.0.0
    • 包版本: 1.35.0
  • 构建包: org.openapitools.codegen.languages.PhpNextgenClientCodegen