magiclabs/magic-admin-php

Magic Admin PHP 库

v1.0.0 2023-07-10 17:40 UTC

This package is auto-updated.

Last update: 2024-09-10 20:09:53 UTC


README

Magic Admin PHP SDK 为开发者提供了与 Magic API 端点交互的便捷方式,并提供了一系列处理 DID Token 的实用工具。

目录

文档

查看 Magic 文档

安装

Composer

您可以通过 Composer 安装这些绑定。运行以下命令:

composer require magiclabs/magic-admin-php

要使用这些绑定,请使用 Composer 的 自动加载

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

手动安装

如果您不想使用 Composer,可以下载 最新版本。然后,要使用这些绑定,请包含 init.php 文件。

require_once __DIR__ . '/path/to/magic-admin-php/init.php';

依赖项

这些绑定需要以下扩展才能正常运行。如果您使用 Composer,这些依赖项应自动处理。如果您手动安装,请确保这些扩展可用。

为了获得最佳性能,请确保您的平台已安装 gmp 扩展。如果您的平台不支持 gmp,则可以使用 bcmath 作为替代,但请注意,bcmath 的速度比 gmp 慢得多。

由于 gmp 是必需依赖项,因此您可能需要在没有 gmp 扩展的平台运行 composer install 时使用 --ignore-platform-reqs 标志。

先决条件

PHP 5.6.0 及更高版本。

快速开始

登录的简单用法

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

  $did_token = \MagicAdmin\Util\Http::parse_authorization_header_value(
    $authorization_header
  );

  if ($did_token === null) {
    // DIDT is missing from the original HTTP request header. You can handle this by
    // remapping it to your application error.
  }

  $magic = new \MagicAdmin\Magic('<YOUR_API_SECRET_KEY>');

  try {
    $magic->token->validate($did_token);
    $issuer = $magic->token->get_issuer($did_token);
  } catch (\MagicAdmin\Exception\DIDTokenException $e) {
    // DIDT is malformed. You can handle this by remapping it
    // to your application error.
  }

配置网络策略

Magic 对象在对象实例化时还接受 retriestimeoutbackoff 作为可选参数,因此您可以覆盖这些值以适应您的应用程序设置。

$magic = new \MagicAdmin\Magic(
  '<YOUR_API_SECRET_KEY>',
  5,    // timeout
  3,    // retries
  0.01  // backoff
);

请参阅 Magic PHP 文档 中的更多示例。

开发

获取 Composer。例如,在 Mac OS 上

brew install composer

安装依赖项

composer install

如上所述安装依赖项(这将解决 PHPUnit),然后您可以运行测试套件

./vendor/bin/phpunit tests/

或运行单个测试文件

./vendor/bin/phpunit tests/MagicTest.php

该库使用 PHP CS Fixer 进行代码格式化。PHP CS Fixer 必须全局安装。在提交 PR 之前,必须格式化代码。使用以下命令运行格式化工具:

php-cs-fixer fix -v --using-cache=no .

变更日志

查看 变更日志

许可

查看 许可