Download the PHP package vinou/api-connector without Composer
On this page you can find all versions of the php package vinou/api-connector. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download vinou/api-connector
More information about vinou/api-connector
Files in vinou/api-connector
Package api-connector
Short Description Vinou API Connnector
License GPL-2.0+
Homepage https://doc.vinou.de
Informations about the package api-connector
Vinou API Connector
The Vinou API Connector is a PHP library that provides the stable functions and utilities that are enabled within the Vinou-Service-API and the Vinou-Public-API.
Table of contents
- Installation
- Usage Example
- Basic Instantiation
- Instantiation with settings (recommended)
- Improve session handling
- Example function call
- Prepare Ajax connection
- Constants
- Classlist
- Provider
Installation
Usage Example
1. Basic instantiation
2. Instantiation with settings (recommended)
At first use constants to define path to config.yml
The settings.yml looks like (Be careful keys are case sensitive)
than you can instantiate without piping the variables to the API-Object
3. Improve session handling
By default the generated login token is stored to session. If you want to configure some additional api parameters or if you have some login issues it is better to instantiate a specific Vinou-Session before.
This session handling is able to detect a TYPO3 session
4. Example function call
5. Prepare Ajax connection (content of ajax.php e.g. called via https://your.domain.com/ajax.php)
Constants
Main options are set by constants. The following constants are avaiable.
Constant | Default | Options | Description |
---|---|---|---|
VINOU_ROOT |
[DOCROOT] | /Path/to/application/dir |
Improvement settings for some older environments if document root is not correctly set via server variable |
VINOU_CONFIG_DIR |
not set | /Path/to/settings.yml |
If set use configuration via settings.yml] |
VINOU_LOG_DIR |
logs/ | /Path/to/log/dir/ |
Directory for logfiles |
VINOU_LOG_LEVEL |
ERROR | Loglevel from monolog | |
VINOU_DEBUG |
false | Boolean | If set special breakpoints in sdk are written to logfiles |
VINOU_MODE |
not set | Shop |
load only objects marked with shop flag in Vinou-Office |
Winelist |
load only objects marked as public in Vinou-Office | ||
VINOU_SOURCE |
Live | Live |
Use production API https://api.vinou.de |
Staging |
Use staging API https://api.staging.vinou.de (Ready to use features) | ||
Dev |
Use development API https://api.developmentvinou.de (All new features up from alpha status) |
Classlist
Class | Description |
---|---|
\Vinou\ApiConnector\Api | Main API SDK class |
\Vinou\ApiConnector\PublicApi | API SDK for small public API |
\Vinou\ApiConnector\Ajax | Class to handle local json ajax requests to API |
\Vinou\ApiConnector\FileHandler\Images | File handling to store and cache api images in local application |
\Vinou\ApiConnector\FileHandler\Pdf | File handling to store and cache api PDFs in local application |
\Vinou\ApiConnector\Session\Session | Main session class to instantiate, get, set and delete session variables |
\Vinou\ApiConnector\Session\TYPO3Session | Class that is used to use TYPO3 sesions |
\Vinou\ApiConnector\Tools\Helper | Some static helper functions e.g. get api urls depending on environment |
\Vinou\ApiConnector\Tools\Redirect | Helper class to do internal and external redirects |
Provider
This Library is developed by the Vinou GmbH.
Vinou GmbH
Mombacher Straße 68
55122 Mainz
E-Mail: [email protected]
Phone: +49 6131 6245390
All versions of api-connector with dependencies
guzzlehttp/guzzle Version *
jaybizzle/crawler-detect Version *
monolog/monolog Version ^2.1.0