hayloft / exivo-client-php
dev-master
2024-08-27 12:20 UTC
Requires
- php: >=5.5
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^7.3
Requires (Dev)
- friendsofphp/php-cs-fixer: ~2.12
- phpunit/phpunit: ^4.8
- squizlabs/php_codesniffer: ~2.6
This package is auto-updated.
Last update: 2024-09-27 12:32:22 UTC
README
exivo API 允许您管理 exivo 网站。要使用 API,需要激活连接服务。对于每个 HTTP 请求,需要 siteId
、API_KEY
和相应的 API_SECRET
。所有这些信息都可以在 exivo 应用 中找到。可以在应用中生成新的 API_KEY
。请注意,API_SECRET
是机密信息,应安全存储。关闭对话框或刷新页面后,秘密将无法再显示。如果丢失秘密,则需要生成新的密钥并删除旧的密钥。
此 PHP 包是由 Swagger Codegen 项目自动生成的
- API 版本:1.1.0
- 构建包:io.swagger.codegen.languages.PhpClientCodegen
需求
PHP 5.5 及以上版本
安装与使用
Composer
要通过 Composer 安装绑定,请将以下内容添加到 composer.json
{
"repositories": [
{
"type": "git",
"url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
}
],
"require": {
"GIT_USER_ID/GIT_REPO_ID": "*@dev"
}
}
然后运行 composer install
手动安装
下载文件并包含 autoload.php
require_once('/path/to/SwaggerClient-php/vendor/autoload.php');
测试
要运行单元测试
composer install
./vendor/bin/phpunit
入门
请按照 安装流程 进行,然后运行以下操作
<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure HTTP basic authorization: basicAuth $config = Exivo\Configuration::getDefaultConfiguration() ->setUsername('YOUR_USERNAME') ->setPassword('YOUR_PASSWORD'); $apiInstance = new Exivo\Api\AccessGroupApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $site_id = "site_id_example"; // string | ID of site to work $person_id = "person_id_example"; // string | ID of person $access_group_id = "access_group_id_example"; // string | ID of access group $body = new \stdClass; // object | try { $apiInstance->assignAccessGroup($site_id, $person_id, $access_group_id, $body); } catch (Exception $e) { echo 'Exception when calling AccessGroupApi->assignAccessGroup: ', $e->getMessage(), PHP_EOL; } ?>
API 端点文档
所有 URI 都相对于 https://api.exivo.io/v1
模型文档
- AccessGroupPayload
- AccessLogEntry
- AccessZone
- Accessgroup
- ActivateDigitalKeyPayload
- ActivateMediumPayload
- AssignMediumPayload
- Body
- Body1
- Body2
- Component
- DigitalKey
- DigitalKeyPayload
- DigitalKeyVisit
- DigitalKeyVisitPayload
- InlineResponse200
- InlineResponse2001
- Medium
- MediumPayload
- MobileApp
- Person
- PersonPayload
- SetOperatingModePayload
- SiteInfo
- SpecialDays
- SpecialDaysInner
- TimeProfile
- TimeProfilePayload
- TimeRange
- UnlockPayload
- Visit
- VisitPayload
授权文档
basicAuth
- 类型:HTTP 基本认证