README

BeezUP系统的REST API

概述

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

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

认证凭据

以基础路径 _/v2/public 的大众API已设置，以便为您提供用户注册、登录和忘记密码的入口点。公共API不需要任何凭据。我们为您提供了一些公共值和公共渠道，用于我们的公共商业网站www.beezup.com。

用户API以基础路径 _/v2/user 需要一个令牌，该令牌可在以下页面找到：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 = EffetB\BeezupApi\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = EffetB\BeezupApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');

$apiInstance = new EffetB\BeezupApi\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 \EffetB\BeezupApi\Model\ConfigureAutoImportIntervalRequest(); // \EffetB\BeezupApi\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

effetb / beezup-api-php-client

维护者

详细信息