Download the PHP package hele/partner-sync-api without Composer

On this page you can find all versions of the php package hele/partner-sync-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of hele/partner-sync-api

Informations about the package partner-sync-api

Hele partner sync API

Build Status Scrutinizer Code Quality

This repository provides PHP client library for synchronization of reservations with Hele.cz website.

Minimal supported version of PHP is 5.3.

Installation

The best way to install this library is using Composer:

Or download archive from Github and extract to your project.

Simple usage

onCreateReservation

This endpoint is called when user creates some order on Hele.cz. You should save new reservation to your database with the data given. If reservation cannot be created for some reason, you can throw any Exception and the reservation on Hele website will not be performed. We call this endpoint only if we know there is a free slot on that time (according to output in onGetSlots), so throwing exceptions should not be needed.

Array provided in $parameters contains (beside your custom data) also following keys: customerName, customerEmail, customerPhone (in format +420777111222), customerNote. Values of all these keys may be null.

onCancelReservation

This endpoint is called when previously created reservation is cancelled. You should delete old reservation from your database to free the time slot. If you do not want to implement this feature, let us know and we will send you an email on such cases (but you will need to perform this action manually).

onGetSlots

This endpoint is called periodically to synchronize reservations on Hele.cz with your database. You should always return all slots from your database (matching given date and parameters) even if only few of them will be available for Hele. The callback must return array of arrays in following format:

Testing implementation

After receiving secret from us (by email), you can test if your implementation works as expected on prepared tool. First check if your API is responding correctly using checkHealth method. Then try to fetch some slots and create reservation. After that, you should see capacity drop on that time where you created the reservation.

All versions of partner-sync-api with dependencies

PHP Build Version
Package Version
Requires php Version ^5.3.3|^7.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package hele/partner-sync-api contains the following files

Loading the files please wait ....