README

Corbado PHP SDK

Corbado PHP SDK 提供了方便的应用程序访问 Corbado 后端 API，这些应用程序是用 PHP 语言编写的。

⚠️ Corbado PHP SDK 通常被称为私有客户端，专门设计用于在封闭后端应用程序中使用。应仅在此类环境中使用此特定 SDK，因为确保 API 密钥严格保密并且决不共享至关重要。

🚀 入门 | 🛠️ 服务 | 📚 高级 | 💬 支持 & 反馈

🚀 入门

要求

PHP 8.0 或更高版本
Composer

安装

使用以下命令安装 Corbado PHP SDK

composer require corbado/php-sdk

用法

要创建 Corbado PHP SDK 实例，您需要提供您的 项目 ID、API 密钥、前端 API URL 和 后端 API URL，这些可以在开发者面板找到。

$config = new Corbado\Config('<Project ID>', '<API secret>', '<Frontend API URL>', '<Backend API URL>');
$sdk = new Corbado\SDK($config);

示例

可以在集成测试的此处找到示例列表。

🛠️ 服务

Corbado PHP SDK 提供以下服务

会话 用于管理会话
用户 用于管理用户（《示例》）
标识符 用于管理标识符（《示例》）

要使用特定服务，例如 会话，请按以下方式调用它

$user = $sdk->sessions()->getCurrentUser();

📚 高级

错误处理

Corbado PHP SDK 对于所有错误都会抛出异常。以下异常会被抛出

AssertException 用于失败的断言（客户端）
ConfigException 用于配置错误（客户端）
ValidationException 用于验证错误（客户端）
ServerException 用于服务器错误（服务器端）
StandardException 用于其他所有情况（客户端）

如果后端 API 返回的不是 200 的 HTTP 状态码，Corbado PHP SDK 会抛出 ServerException。ServerException 类提供了方便的方法来访问所有重要数据

try {
    // Try to get non-existing user with ID 'usr-123456789'
    $user = $sdk->users()->get('usr-123456789');
} catch (ServerException $e) {
    // Show HTTP status code (400 in this case)
    echo $e->getHttpStatusCode() . PHP_EOL;
    
    // Show request ID (can be used in developer panel to look up the full request
    // and response, see https://app.corbado.com/app/logs/requests)
    echo $e->getRequestID() . PHP_EOL;
    
    // Show full request data
    var_dump($e->getRequestData());
    
    // Show runtime of request in seconds (server side)
    echo $e->getRuntime() . PHP_EOL;
    
    // Show validation error messages (server side validation in case of HTTP
    // status code 400 (Bad Request))
    var_dump($e->getValidationMessages());
    
    // Show full error data
    var_dump($e->getError());
}

💬 支持 & 反馈

报告问题

如果您遇到任何错误或有建议，请打开一个问题。

Slack 频道

加入我们的 Slack 频道，与 Corbado 团队和其他开发者讨论问题或想法。

电子邮件

您也可以通过电子邮件 vincent.delitz@corbado.com 联系我们。

漏洞报告

请将疑似的安全漏洞私下报告给 security@corbado.com。请勿创建公开可见的问题来报告疑似的安全漏洞。

corbado / php-sdk

维护者

详细信息