stromhalm / fastbill-php
FastBill.com API的包装器
Requires
- php: >=5.3.0
This package is auto-updated.
Last update: 2024-09-29 06:03:13 UTC
README
#Fastbill
这是一个小型的PHP库,允许您通过Fastbill API进行通信。这样,您可以轻松地访问和处理Fastbill数据,无需太多先验知识。
在Fastbill-API 文档中,您可以找到各个请求的结构。这些请求必须以数组的形式传递给类。最简单的方法是参照文档中的 Request - JSON 示例。
##安装
绑定最新版本,并使用您的Fastbill电子邮件和APIKey初始化fastbill类。
require("FastBill.php"); $fastbill = new \FastBill\FastBill(string $email, string $apiKey [, string $apiUrl = FASTBILL_PLUS]);
将$email替换为您Fastbill电子邮件地址(例如,max@mustermann.de),将$apiKey替换为您Fastbill APIKey(例如,1238751bd8714ciafnafv3afubafeGizQnudJHBzfaiusbwt48)。如果您忘记或这些参数为空,则new fastbill()返回False。
可选地,您可以作为3个参数传递APIURL。
或者通过Composer绑定包装器
{
"stromhalm/fastbill-php": "dev-master"
}
##类
###调试模式
$fastbill->setDebug(bool $status = false);
使用这个类可以激活或关闭调试模式。默认情况下,调试模式是关闭的。
一旦激活了调试模式,在发生错误时,您将收到一个数组,其格式为:array("RESPONSE" => array("ERROR" => array("错误1","错误2",...)));。
###请求
$fastbill->request(array $request [, string $file]);
这个类期望一个包含请求数据的数组:Service [, Filter, Limit, Offset 和 Data]。作为返回,您将获得Fastbill的响应数组。如果发生错误,将返回False或调试数组。
如果您要传递一个文件,您可以直接传递到所需文件的完整服务器路径,或者在上传后使用$_FILES[%parameter%]["tmp_name"]。
##示例
###发票
// Als Rückgabe erhalten Sie alle Rechnungen $temp = $fastbill->request(array("SERVICE" => "invoice.get")); print_r($temp); // Hier alle Ausgangsrechnungen $temp = $fastbill->request(array("SERVICE" => "invoice.get", "FILTER" => array("TYPE" => "outgoing"))); print_r($temp); // Und hier die ersten drei Ausgangsrechnungen $temp = $fastbill->request(array("SERVICE" => "invoice.get", "FILTER" => array("TYPE" => "outgoing"), "LIMIT" => 3)); print_r($temp);
###客户
// Als Rückgabe erhalten Sie alle Kunden $temp = $fastbill->request(array("SERVICE" => "customer.get")); print_r($temp); // Hier den Kunden mit der ID 5376 $temp = $fastbill->request(array("SERVICE" => "invoice.get", "FILTER" => array("CUSTOMER_ID" => 5376))); print_r($temp);