此包的最新版本(dev-master)没有可用的许可信息。

Lob API

dev-master 2015-06-11 19:12 UTC

This package is not auto-updated.

Last update: 2024-09-18 07:16:18 UTC


README

Lob为开发者构建了用于打印和邮寄的API。它使得发送明信片、支票和信件变得轻而易举。它甚至还提供基本的地址验证。

这是一个连接并使用Lob API的库。

安装

首先,安装Composer

然后,需要此包。

composer require 'brianseitel/lob:dev-master'

使用

此库设计得尽可能简单易用。您只需要API密钥,您可以在仪表板上找到它。您的API密钥将放入config/app.php文件中。它看起来像这样

<?php

return [
    'lob' => [
        'api_key' => 'YOUR_API_KEY_GOES_HERE'
    ]
];

现在,您可以使用API库这样使用

$api_key = Lob\Config::get('lob.api_key');
$lob = new Lob\Api($api_key);

$results = $lob->request('get', 'addresses', []); // List all addresses

完整的签名是:$lob->request($action, $endpoint, $data)

  • $action必须是标准HTTP动词之一(不区分大小写):GET、POST、PUT、DELETE、PATCH
  • $endpoint必须是Lob开发者文档中详细说明的端点之一。
  • $data必须是参数的数组。此库不检查参数的有效性。

贡献

  1. 进行分支操作!
  2. 创建您的功能分支:git checkout -b my-new-feature
  3. 提交您的更改:git commit -am '添加一些功能'
  4. 推送到分支:git push origin my-new-feature
  5. 提交拉取请求 :D

许可

MIT许可(MIT)

版权(c)2015 Brian Seitel

特此授予任何获得此软件及其相关文档副本(“软件”)的人免费使用软件的权利,不受限制地处理软件,包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或销售软件副本,并允许向软件提供者提供软件的人这样做,前提是遵守以下条件

上述版权声明和本许可声明应包含在软件的所有副本或主要部分中。

软件按“原样”提供,不提供任何形式的保证,明示或暗示,包括但不限于适销性、适用于特定目的和无侵权性保证。在任何情况下,作者或版权所有者均不对任何索赔、损害或其他责任承担责任,无论是基于合同、侵权或其他原因,源于、因或与软件或其使用或其他方式有关。