PHPackages                             effetb/beezup-api-php-client - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. effetb/beezup-api-php-client

ActiveLibrary[API Development](/categories/api)

effetb/beezup-api-php-client
============================

The REST API of BeezUP system

v1.1(2y ago)060↓50%MITPHPPHP >=7.4

Since May 31Pushed 2y agoCompare

[ Source](https://github.com/effetb/beezup-api-php-client)[ Packagist](https://packagist.org/packages/effetb/beezup-api-php-client)[ Docs](https://api-docs.beezup.com)[ RSS](/packages/effetb-beezup-api-php-client/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (1)Dependencies (4)Versions (8)Used By (0)

SwaggerClient-php
=================

[](#swaggerclient-php)

### The REST API of BeezUP system

[](#the-rest-api-of-beezup-system)

##### Overview

[](#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  !
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

[](#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](http://www.beezup.com).

The user API with the base path **\_/v2/user** requires a token which is available on this page:

### Things to keep in mind

[](#things-to-keep-in-mind)

##### API Rate Limits

[](#api-rate-limits)

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

##### Media type

[](#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

[](#required-content-type)

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

##### Required date time format

[](#required-date-time-format)

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

##### Base URL

[](#base-url)

The Base URL of the BeezUP API Order Management REST API conforms to the following template.  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\\\\](https://api-docs.beezup.com/swagger-ui%5C%5C) You can contact us on [gitter, #BeezUP/API](https://gitter.im/BeezUP/API)

This PHP package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

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

Requirements
------------

[](#requirements)

PHP 5.5 and later

Installation & Usage
------------------------

[](#installation--usage)

### Composer

[](#composer)

To install the bindings via [Composer](http://getcomposer.org/), 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

[](#manual-installation)

Download the files and include `autoload.php`:

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

Tests
-----

[](#tests)

To run the unit tests:

```
composer install
./vendor/bin/phpunit

```

Getting Started
---------------

[](#getting-started)

Please follow the [installation procedure](#installation--usage) and then run the following:

```