Download the PHP package pitwch/rest-api-wrapper-proffix-php without Composer
On this page you can find all versions of the php package pitwch/rest-api-wrapper-proffix-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download pitwch/rest-api-wrapper-proffix-php
More information about pitwch/rest-api-wrapper-proffix-php
Files in pitwch/rest-api-wrapper-proffix-php
Package rest-api-wrapper-proffix-php
Short Description PHP Wrapper for PROFFIX REST API
License MIT
Homepage https://www.pitw.ch
Informations about the package rest-api-wrapper-proffix-php
PHP Wrapper für PROFFIX REST-API
Ein effizienter PHP Wrapper für die PROFFIX REST-API.
Installation
Der Wrapper kann via Composer installiert werden.
Konfiguration
Initialisierung
Autoload der RestAPIWrapperProffix
Klasse:
Die Konfiguration wird dem Client mitgegeben:
Konfiguration | Beispiel | Bemerkung |
---|---|---|
url | https://myserver.ch:999 |
URL der REST-API ohne pxapi/v2/ |
apiDatabase | DEMO |
Name der Datenbank |
apiUser | USR |
Name des Benutzers |
apiPassword | b62cce2fe18f7a156a9c... |
SHA256-Hash des Benutzerpasswortes |
apiModule | ADR,STU |
Benötigte Module (mit Komma getrennt) |
options | array('key'=>'112a5a90...') |
Optionen (Details unter Optionen) |
Beispiel für die Initialisierung
Optionen
Optionen sind fakultativ und werden in der Regel nicht benötigt:
Option | Beispiel | Bemerkung |
---|---|---|
key | 112a5a90fe28b... |
API-Key als SHA256 - Hash (kann auch direkt mitgegeben werden) |
version | v2 |
API-Version; Standard = v2 |
api_prefix | /pxapi/ |
Prefix für die API; Standard = /pxapi/ |
login_endpoint | PRO/Login |
Endpunkt für Login; Standard = PRO/Login |
user_agent | php-wrapper-proffix-restapi |
User Agent; Standard = php-wrapper-proffix-restapi |
timeout | 15 |
Timeout für Curl in Sekunden; Standard = 15 |
follow_redirects | true |
Weiterleitungen der API folgen; Standard = false |
Methoden
Allgemeine Methoden (get
, put
, post
, delete
)
Parameter | Typ | Bemerkung |
---|---|---|
endpoint | string |
Endpunkt der PROFFIX REST-API; z.B. ADR/Adresse , STU/Rapporte ... |
data | array |
Daten (werden automatisch in JSON konvertiert); z.B: ["Name"=>"Demo AG",...] |
parameters | array |
Parameter gemäss PROFFIX REST API Docs |
Sonderzeichen in den Parametern müssen gegebenfalls mit Escape-Zeichen verwendet werden, z.B:
Get / Query
Put / Update
Post / Create
Delete
Spezifische Methoden
getList(int $listenr, array $body = [])
Generiert eine PROFFIX-Liste (z.B. ein PDF) und gibt das Ergebnis als Response
-Objekt zurück, welches den rohen Dateiinhalt enthält.
Parameter | Typ | Bemerkung |
---|---|---|
$listenr |
int |
Die ListeNr der Liste, die generiert werden soll. |
$body |
array |
(Optional) Ein assoziatives Array mit Parametern für die Listengenerierung. Wichtig: Es muss mindestens ein leeres JSON-Objekt ({} ) gesendet werden. |
Beispiel:
Spezielle Endpunkte
Info
Ruft Infos vom Endpunkt PRO/Info
ab.
Hinweis: Dieser Endpunkt / Abfrage blockiert keine Lizenz.
Datenbank
Ruft Infos vom Endpunkt PRO/Datenbank
ab.
Response / Antwort
Alle Methoden geben die Response als Array bzw. NULL
(z.B. bei DELETE
) zurück. Bei Fehlern wird eine HttpClientException
mit der Rückmeldung der PROFFIX REST-API geworfen.
Zudem lassen sich Zusatzinformationen zur letzten Response wie folgt ausgeben:
Letzter Request
Letzte Response
Ausnahmen / Spezialfälle
- Endpunkte, welche Leerschläge enthalten (z.B.
LAG/Artikel/PC 7/Bestand
), müssen mitrawurlencode()
genutzt werden.
Weitere Beispiele
Im Ordner /examples finden sich weitere auskommentierte Beispiele.
Weitere Wrapper für die Proffix Rest-API
All versions of rest-api-wrapper-proffix-php with dependencies
ext-curl Version *
ext-json Version *