README

Lob API 是基于 REST 组织的。我们的 API 设计有可预测的资源导向 URL，并使用 HTTP 响应代码来指示任何 API 错误。

更多信息，请访问 我们的 API 文档。寻找我们的 遗留 PHP SDK？

要求

PHP 7.3 及以上。也应该能与 PHP 8.0 一起工作，但尚未进行测试。

入门

注册

首先，您需要先在 Lob.com 上创建账户并获取测试和实时 API 密钥。

创建账户后，您可以从 设置面板 访问您的 API 密钥。

安装与使用

Composer

要通过 Composer 安装绑定，请运行 php composer.phar install

手动安装

下载文件并包含 autoload.php

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

第一次 API 调用

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure HTTP basic authorization: basicAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new OpenAPI\Client\Api\AddressesApi(
    // 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
);
$address_editable = new \OpenAPI\Client\Model\AddressEditable(); // \OpenAPI\Client\Model\AddressEditable

try {
    $result = $apiInstance->addressCreate($address_editable);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AddressesApi->addressCreate: ', $e->getMessage(), PHP_EOL;
}

API 文档

Lob API 的完整和综合文档可在 此处 获取。

授权

basicAuth

• 类型: HTTP 基本认证

测试

在运行测试之前，

$ composer install

单元测试

$ vendor/bin/phpunit --group unit --coverage-text --coverage-html coverage/html

集成测试

集成测试针对 Lob API 的实时部署运行，需要多个具有访问特定功能的有效 API 密钥。因此，这些测试不会在所有用户的所有环境中通过。

要运行集成测试

$ LOB_API_TEST_KEY=<<YOUR TEST KEY>> LOB_API_LIVE_KEY=<<YOUR LIVE KEY>> vendor/bin/phpunit --group integration --coverage-text --coverage-html coverage/html

如果您经常运行集成测试，这是一个更干净的替代方案

首次运行此操作

$ echo "LOB_API_TEST_KEY=<<YOUR TEST KEY>> LOB_API_LIVE_KEY=<<YOUR LIVE KEY>>" > LOCAL.env

然后，运行集成测试

$ env $(cat LOCAL.env) vendor/bin/phpunit --group integration --coverage-text --coverage-html coverage/html

作者

lob-openapi@lob.com

关于此包

此 PHP 包是由 OpenAPI Generator 项目自动生成的

• API 版本: 1.3.0
  • 包版本: 1.0.0
• 构建包: org.openapitools.codegen.languages.PhpClientCodegen