2017 © Pedro Pel├íez
 

library fastbill

API Wrapper for the FastBill.com API

image

zweischneider/fastbill

API Wrapper for the FastBill.com API

  • Wednesday, February 7, 2018
  • by zweischneider
  • Repository
  • 2 Watchers
  • 16 Stars
  • 24 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 5 Forks
  • 1 Open issues
  • 1 Versions
  • 20 % Grown

The README.md

Fastbill

Dies ist eine kleine Library um mittels PHP mit der Fastbill API kommunizieren zu k├Ânnen. So k├Ânnen Sie mit wenigen Schritten und wenig Vorkenntnissen auf Ihre Fastbill-Daten zugreifen und diese verarbeiten., (*1)

In der Fastbill-API Dokumentation finden Sie die Struktur der einzelnen Requests. Diese m├╝ssen in Form von Arrays an die Klasse ├╝bergeben werden. Am einfachsten ist es, sich an die Request - JSON Beispiele aus der Dokumentation zu halten., (*2)

Installation

Binden Sie die aktuellste Version ein und initialisieren Sie die fastbill-Klasse mit Ihrer Fastbill-Email und APIKey., (*3)

``` php require("FastBill.php"); $fastbill = new \FastBill\FastBill(string $email, string $apiKey [, string $apiUrl = FASTBILL_PLUS]);, (*4)

Ersetzen Sie <code>$email</code> durch Ihre Fastbill-E-Mail-Adresse (z.B. *max@mustermann.de*) und <code>$apiKey</code> durch Ihren Fastbill-APIKey (z.B. *1238751bd8714ciafnafv3afubafeGizQnudJHBzfaiusbwt48*). Sollten Sie die Parameter vergessen oder diese Leer sein gibt <code>new fastbill()</code> *False* zur├╝ck.

Optional k├Ânnen Sie als 3 Parameter die APIURL ├╝bergeben.

Oder binden Sie den Wrapper ├╝ber Composer ein:

``` php
{
    "zweischneider/fastbill": "dev-master"
}

Klassen

Debug-Modus

``` php $fastbill->setDebug(bool $status = false);, (*5)

Mit dieser Klasse k├Ânnen Sie den Debug-Modus aktivieren oder deaktivieren. Standardm├Ą├čig ist der Debug-Modus deaktiviert.

Sobald der Debug-Modus aktiviert wurde erhalten Sie bei Fehlerf├Ąllen ein Array in dem Format: <code>array("RESPONSE" => array("ERROR" => array("Fehler1","Fehler2",...)));</code> zur├╝ck.

###Request
``` php
$fastbill->request(array $request [, string $file]);

Diese Klasse erwartet ein Array mit den Request Daten: Service [, Filter, Limit, Offset und Data]. Als R├╝ckgabe erhalten Sie die Fastbill Antwort in einem Array. Sollte es zu Fehlern kommen, erhalten Sie als R├╝ckgabe False oder das Debugarray., (*6)

Wenn Sie eine Datei ├╝bergeben m├Âchten k├Ânnen Sie entweder den kompletten Pfad des Servers zu der gew├╝nschten Datei ├╝bergeben oder nach dem Hochladen $_FILES[%parameter%]["tmp_name"]., (*7)

Beispiele

Rechnungen

``` php // Als R├╝ckgabe erhalten Sie alle Rechnungen $temp = $fastbill->request(array("SERVICE" => "invoice.get")); print_r($temp);, (*8)

// Hier alle Ausgangsrechnungen $temp = $fastbill->request(array("SERVICE" => "invoice.get", "FILTER" => array("TYPE" => "outgoing"))); print_r($temp);, (*9)

// Und hier die ersten drei Ausgangsrechnungen $temp = $fastbill->request(array("SERVICE" => "invoice.get", "FILTER" => array("TYPE" => "outgoing"), "LIMIT" => 3)); print_r($temp);, (*10)


###Kunden ``` php // 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);

The Versions

07/02 2018

dev-master

9999999-dev

API Wrapper for the FastBill.com API

  Sources   Download

GPL-2.0-or-later

The Requires

  • php >=5.3.0

 

by ZWEISCHNEIDER GmbH & Co. KG