README

Vinou API 连接器是一个 PHP 库，它提供了在 Vinou-Service-API 和 Vinou-Public-API 中启用的稳定功能和工具。

目录

• 安装
• 使用示例
  1. 基本实例化
  2. 带有设置的实例化（推荐）
  3. 改进会话处理
  4. 示例函数调用
  5. 准备 Ajax 连接
• 常量
• 类列表
• 提供者

安装

composer install vinou/api-connector

使用示例

1. 基本实例化

$api = new \Vinou\ApiConnector\Api (
        TOKEN_FOR_INSTANCE,
        AUTHID_FOR_VINOU_CUSTOMER	
      );

2. 带有设置的实例化（推荐）

首次使用时，请使用常量定义 config.yml 的路径

define(VINOU_CONFIG_DIR, '/Path/to/settings.yml');

settings.yml 的样子（注意键是区分大小写的）

vinou:
    token: TOKEN_FOR_INSTANCE
    authid: AUTHID_FOR_VINOU_CUSTOMER

然后你可以实例化而不需要将变量传递给 API-Object

$api = new \Vinou\ApiConnector\Api();

3. 改进会话处理

默认情况下，生成的登录令牌存储在会话中。如果您想配置一些额外的 API 参数或遇到登录问题，最好在之前实例化一个特定的 Vinou-Session。

$session = new \Vinou\ApiConnector\Session\Session ();
$session::setValue('language','de');

这个会话处理能够检测 TYPO3 会话

4. 示例函数调用

// returns all public wines of your Vinou-Office Account as php array
$api->getWinesAll()

5. 准备 Ajax 连接（ajax.php 的内容，例如通过 https://your.domain.com/ajax.php 调用）

<?php
        require_once __DIR__ . '/../vendor/autoload.php';

        define('VINOU_ROOT', realpath('./'));
        define('VINOU_MODE', 'Ajax');
        define('VINOU_CONFIG_DIR', '../config/');

        header('Cache-Control: no-cache, must-revalidate');
        header('Content-type: application/json');

        // INIT SESSION BEFORE ALL THE OTHER STUFF STARTS
        $session = new \Vinou\ApiConnector\Session\Session ();
        $session::setValue('language','de');

        $ajax = new \Vinou\ApiConnector\Ajax ();
        $ajax->run();
?>

常量

主要选项通过常量设置。以下常量可用。

类列表

提供者

本库由 Vinou GmbH 开发。

Vinou GmbH
Mombacher Straße 68
55122 Mainz
电子邮件：kontakt@vinou.de
电话：+49 6131 6245390