Skip to content

implementation-examples.md

Latest commit

 

History

History
59 lines (44 loc) · 1.59 KB

implementation-examples.md

File metadata and controls

59 lines (44 loc) · 1.59 KB

Implementierungsbeispiele

Ziel

Diese Beispiele zeigen typische Integrationspfade fuer reale PHP-Projekte.

Verfuegbare Beispiele

  • examples/pat_list_contacts.php
    • einfacher Start mit Personal Access Token
  • examples/contact_search.php
    • POST-basierte Search-Operation mit Query und Filter-Body
  • examples/file_upload.php
    • multipart/form-data Upload ueber die generierte Files-Ressource
  • examples/invoice_pdf_download.php
    • Abruf eines bexio-intern base64-kodierten PDF-Dokuments
  • examples/oauth_refresh_client.php
    • Aufbau eines refresh-faehigen OAuth-Clients

Signaturmuster

Nur Query

$client->contacts()->v2ListContacts(['limit' => 20]);

Path plus Query

$client->contacts()->v2ShowContact(['contact_id' => 123]);

Body plus Query

$client->contacts()->v2SearchContact(
    [
        ['field' => 'name_1', 'value' => 'Example Company', 'criteria' => '='],
    ],
    ['limit' => 20],
);

Path plus Body

$client->contacts()->v2EditContact(
    ['contact_id' => 123],
    ['remarks' => 'Updated by integration'],
);

Hinweise fuer produktive Integrationen

  • Path-Parameter werden als assoziatives Array uebergeben und gegen die Template-Platzhalter validiert.
  • Search- und Schreiboperationen verwenden die von bexio dokumentierten JSON-Strukturen unveraendert.
  • Multipart-Operationen erwarten assoziative Arrays; Dateien werden ueber ein Feld mit contents, filename und optional content_type uebergeben.
  • PDF-Endpunkte liefern laut bexio-Doku JSON mit base64-kodiertem Inhalt, nicht direkt einen binaren Stream.