README

The REST API of BeezUP system

Overview

The REST APIs provide programmatic access to read and write BeezUP data. Basically, with this API you will be able to do everything like you were with your browser on https://go.beezup.com !
The main features are:

Register and manage your account
Create and manage and share your stores with your friends/co-workers.
Import your product catalog and schedule the auto importation - Search the channels your want to use
Configure your channels for your catalogs to export your product information:
cost and general settings
category and columns mappings
your will be able to create and manage your custom column
put in place exlusion filters based on simple conditions on your product data
override product values
get product vision for a channel catalog scope
Analyze and optimize your performance of your catalogs on all yours channels with different type of reportings by day, channel, category and by product.
Automatize your optimisation by using rules! - And of course... Manage your orders harvested from all your marketplaces:
Synchronize your orders in an uniformized way
Get the available actions and update the order status - ...and more!

Authentication credentials

The public API with the base path _/v2/public have been put in place to give you an entry point to our system for the user registration, login and lost password. The public API does not require any credentials. We give you the some public list of values and public channels for our public commercial web site www.beezup.com.

The user API with the base path _/v2/user requires a token which is available on this page: https://go.beezup.com/Account/MyAccount

Things to keep in mind

API Rate Limits

The BeezUP REST API is limited to 100 calls/minute.

Media type

The default media type for requests and responses is application/json. Where noted, some operations support other content types. If no additional content type is mentioned for a specific operation, then the media type is application/json

Required content type

The required and default encoding for the request and responses is UTF8.

Required date time format

All our date time are formatted in ISO 8601 format: 2014-06-24T16:25:00Z.

Base URL

The Base URL of the BeezUP API Order Management REST API conforms to the following template. https://api.beezup.com All URLs returned by the BeezUP API are relative to this base URL, and all requests to the REST API must use this base URL template. You can test our API on https://api-docs.beezup.com/swagger-ui\\ You can contact us on gitter, #BeezUP/API

This PHP package is automatically generated by the Swagger Codegen project:

API version: 2.0
Build package: io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

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

Then run composer install

Manual Installation

Download the files and include autoload.php:

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

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?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;
}

?>

Documentation for API Endpoints

All URIs are relative to https://api.beezup.com/v2

Documentation For Models

Documentation For Authorization

api_key

Type: API key
API key parameter name: Ocp-Apim-Subscription-Key
Location: HTTP header

Author

help@beezup.com

effetb / beezup-api-php-client

Maintainers

Details