Download the PHP package daniel-jorg-schuppelius/orgamax-php-sdk without Composer

On this page you can find all versions of the php package daniel-jorg-schuppelius/orgamax-php-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of daniel-jorg-schuppelius/orgamax-php-sdk

Informations about the package orgamax-php-sdk

orgaMAX PHP SDK

PHP Version License PHP Composer

Ein modernes PHP-SDK für die orgaMAX-API — nach dem Vorbild von lexoffice-php-sdk und datev-php-sdk, aufgebaut auf dem php-api-toolkit.

🚀 Features

📋 Voraussetzungen

📦 Installation

⚙️ Konfiguration

Die orgaMAX-API nutzt einen zweistufigen Auth-Flow:

  1. In der orgaMAX-Anwendung als App-Entwickler registrieren und unter Marketplace → Eigene Erweiterungen eine Erweiterung anlegen.
  2. API-Schlüssel und geheimen API-Schlüssel notieren.
  3. Die ownershipId aus der Callback-URL der Erweiterung entnehmen (Query-Parameter iid).
  4. Gewünschte API-Zugriffe der Erweiterung unter API-Zugriffe freischalten.

📚 Verwendung

Artikel anlegen und suchen

Kunden verwalten

Rechnung abrufen, Zahlung erfassen, PDF laden

Datei hochladen und analysieren

🏗️ Projektstruktur

🔌 API-Endpunkte

Endpoint Routen Beschreibung
AuthEndpoint POST /auth/token Bearer-Token aus ownershipId beziehen
ArticlesEndpoint CRUD + Liste /article Artikelverwaltung
CustomersEndpoint Create/Get/Update + Liste /customer Kundenverwaltung
SuppliersEndpoint CRUD + Liste /supplier Lieferantenverwaltung
InvoicesEndpoint /invoice: Get, Liste, Payment, Lock, Send, Document (PDF) Rechnungen
OffersEndpoint /offer: Create, Update, Get, Liste, Document (PDF) Angebote
OrdersEndpoint /order: Create, Get, Liste, Document, Order→Invoice Aufträge
DeliveryNotesEndpoint /deliveryNote: Get, Liste, Document (PDF) Lieferscheine
ExpensesEndpoint CRUD + Liste /expense, Receipt-Delete Ausgaben
FilesEndpoint /file: Upload, Download, Meta, Analyze, Delete, Liste Dokumente & Belegerkennung
TodosEndpoint /todo: Create, Liste, Messages, Link/Unlink, Status, DueDate To-dos
TagsEndpoint GET /tags Tags
UsersEndpoint GET /user Benutzer
BookkeepingEndpoint GET /bookkeeping/getchartofaccounts Kontenrahmen
Settings\* /setting/account, /setting/miscellaneous, /setting/article, /setting/payCondition, /setting/deliveryCondition Einstellungen

Eigenheiten der API (Statuscodes, Trailing Slashes, Spec-Tippfehler) sind in docs/OpenAPI/orgamax-openapi.json.

🧪 Tests

Live-Tests gegen die echte API: .samples/config.json.sample nach .samples/config.json kopieren, Zugangsdaten eintragen und ORGAMAX_SKIP_API_TESTS in phpunit.xml entfernen bzw. auf 0 setzen.

📖 Abhängigkeiten

Paket Zweck
daniel-jorg-schuppelius/php-api-toolkit ClientAbstract (Guzzle, Retry, Throttling), EndpointAbstract, NamedEntity/NamedValues (Hydration), Exceptions, Auth-Strategien
guzzlehttp/guzzle (transitiv) HTTP-Transport
dschuppelius/php-error-toolkit (transitiv) Logging (PSR-3), ErrorLog-Trait
dschuppelius/php-config-toolkit (transitiv) Config-Loader für Live-Tests

📄 Lizenz

MIT — siehe LICENSE.

👤 Autor

Daniel Jörg Schuppelius — schuppelius.org

All versions of orgamax-php-sdk with dependencies

PHP Build Version
Package Version
Requires php Version >=8.2 <8.6
daniel-jorg-schuppelius/php-api-toolkit Version ^2.8
dschuppelius/php-common-toolkit Version ^1.20 || ^2.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package daniel-jorg-schuppelius/orgamax-php-sdk contains the following files

Loading the files please wait ...