xequals-nz/nec-id-php

0.1 2020-03-23 11:04 UTC

This package is auto-updated.

Last update: 2024-09-22 01:13:29 UTC


README

此包将NEC ID REST API与PHP连接起来。

API文档可在 https://docs.id.nec.com.au/en/latest/ 上找到。

安装

只需从composer中要求此包。

composer require xequals-nz/nec-id-php

进行中

这是此库实现的API端点的状态

  • 生物识别
    • 主题 ✅
    • 标签 ✅
    • 面部 ✅
    • 事件: #1
    • 作业: #2
  • 租户管理
    • 相册 ✅
    • 应用 ✅

使用dotenv的示例

注意,这可以在没有dotenv的情况下实例化,只需将凭证作为数组传递到setCredentials方法中即可。

  1. 将.env.example复制到.env并填写所需的键。
  • 访问密钥
  • 秘密密钥
  • AWS区域(此值通常应为ap-southeast-2)
  • API端点(此值通常应为 https://api.id.nec.com.au/v1.1
  • 应用程序的API密钥
  1. 确保dotenv已加载
require __DIR__ .'/../vendor/autoload.php';
$dotenv = \Dotenv\Dotenv::createImmutable(__DIR__ . '/..');
$dotenv->load();
  1. 加载凭证
\NecId\Resource::setCredentials();
  1. 实例化所需的类,例如,标签。
$tag_resource = new Tag();
  1. 调用方法,例如,列出标签。
$tag_resource->listTags()

许可

此项目受MIT许可证的许可 - 有关详细信息,请参阅LICENSE.md文件。

致谢