README

BeezUP系统的REST API

概览

REST API提供了对BeezUP数据的编程访问权限。基本上，通过这个API，你将能够做所有像在https://go.beezup.com浏览器上一样的事情！
主要功能包括

注册和管理您的账户
创建和管理与您的朋友/同事共享的商店。
导入您的产品目录并安排自动导入 - 搜索您想使用的渠道
配置您的目录渠道以导出您的产品信息
成本和常规设置
分类和列映射
您可以创建和管理自定义列
根据您的产品数据中的简单条件放置排除过滤器
覆盖产品值
获取渠道目录范围内的产品视图
通过不同类型的报告（按日、渠道、分类和按产品）分析并优化您在所有渠道上的目录性能。
使用规则自动化您的优化！ - 当然...管理来自所有市场的订单
以统一的方式同步您的订单
获取可用的操作并更新订单状态 - ...还有更多！

身份验证凭据

带有基本路径 _/v2/public 的公共API已设置，以提供用户注册、登录和找回密码的系统入口点。公共API不需要任何凭据。我们为您提供了一些公共列表值和公共渠道，用于我们的公共商业网站www.beezup.com。

带有基本路径 _/v2/user 的用户API需要令牌，该令牌可在以下页面找到： https://go.beezup.com/Account/MyAccount

需要注意的事项

API速率限制

BeezUP REST API限制为每分钟100次调用。

媒体类型

请求和响应的默认媒体类型为application/json。在注明的操作中，一些操作支持其他内容类型。如果没有提及特定操作的其他内容类型，则媒体类型为application/json

所需内容类型

请求和响应所需和默认编码为UTF8。

所需日期时间格式

所有我们的日期时间均采用ISO 8601格式：2014-06-24T16:25:00Z。

基本URL

BeezUP API订单管理REST API的基本URL符合以下模板：https://api.beezup.com。BeezUP API返回的所有URL均相对于此基本URL，并且所有对REST API的请求都必须使用此基本URL模板。您可以在https://api-docs.beezup.com/swagger-ui\\测试我们的API。您可以通过gitter, #BeezUP/API联系我们。

此PHP包由Swagger Codegen项目自动生成

API版本：2.0
构建包：io.swagger.codegen.languages.PhpClientCodegen

要求

PHP 5.5及更高版本

安装与使用

Composer

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

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/BeezUP/api-php-client.git"
    }
  ],
  "require": {
    "beezup/api-php-client": "*@dev"
  }
}

然后运行composer install

手动安装

下载文件并包含autoload.php

    require_once('/path/to/SwaggerClient-php/vendor/autoload.php');

测试

要运行单元测试

composer install
./vendor/bin/phpunit

入门指南

请遵循安装流程，然后运行以下命令

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

// Configure API key authorization: api_key
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');

$apiInstance = new Swagger\Client\Api\CatalogsAutoApi(
    // 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
);
$store_id = "store_id_example"; // string | Your store identifier
$request = new \Swagger\Client\Model\ConfigureAutoImportIntervalRequest(); // \Swagger\Client\Model\ConfigureAutoImportIntervalRequest | 

try {
    $apiInstance->autoConfigureAutoImportInterval($store_id, $request);
} catch (Exception $e) {
    echo 'Exception when calling CatalogsAutoApi->autoConfigureAutoImportInterval: ', $e->getMessage(), PHP_EOL;
}

?>

API端点文档

所有URI均相对于https://api.beezup.com/v2

模型文档

授权文档

api_key

类型：API密钥
API密钥参数名称：Ocp-Apim-Subscription-Key
位置：HTTP头部

作者

help@beezup.com

beezup / api-php-client

维护者

详细信息