danil005/php-vixcar-sdk

dev-master 2019-03-10 19:14 UTC

This package is auto-updated.

Last update: 2024-09-11 14:48:23 UTC


README

PHP版本SDK,用于与VixCar项目API交互。

内容

  1. 安装
  2. 基本调用
  3. 方法描述

安装

所需依赖

  1. PHP >= 7.1
  2. php-curl-class/php-curl-class: ^8.5

composer require danil005/php-vixcar-sdk:dev-master

基本调用

<?php  
  
require("vendor/autoload.php");  
  
use VixCarSdk\Client;  

$clientID = 2;
$token = "saffnapo";
$urlApi = "http://carplace.ru/api/v1";  

$client = new Client($clientId, $token, $urlApi);  

print_r($client->account()->get()); // is array

方法描述

所有方法基于VixCar.Ru项目的REST API。

认证

认证 > 登录

用户认证。

$client->auth()->login($username, $password);

参数描述

认证 > 加入

创建新用户。

$client->auth()->join($username, $password, $email, $name, $surname, $middleName, $numberPhone)

参数描述

认证 > 登出

退出账户(结束会话)。

$client->auth()->logout()

服务

服务 > 获取

获取服务信息。

$client->services()->get();

服务 > 计数

获取服务数量。

$client->services()->count();

服务 > 价格

获取服务价格表。

$client->services()->price($id);

参数描述

汽车

汽车 > 获取

获取所有汽车信息。

$client->cars()->get();

汽车 > 创建

为用户添加新汽车。

$client->cars()->create($carName, $carNumber, $vin);

参数描述

汽车 > 删除

删除用户汽车。

$client->cars()->delete($id);

参数描述

汽车 > 更新

更新用户汽车信息。

$client->cars()->update($id, $carName, $carNumber, $vin);

参数描述

*指定以下之一。

汽车 > 计数

显示用户汽车数量。

$client->cars()->count();