API-Dokumentation

Ihr findet die API-Dokumentation für eure Instanz wenn ihr angemeldet seid rechts oben (bei deinem Avatar) im Einstellungs-Menü.

Wenn du keinen Zugang zu einer Instanz hast, kannst du dir die API-Dokumentation hier ansehen:

https://system.dieagenturverwaltung.de/app/docs/api

Die API für dein System ist unter der Mandanten-URL deines Systems erreichbar z.B.:

https://meinefirma.dieagenturverwaltung.de

Dokumentation:
https://meinefirma.dieagenturverwaltung.de/app/docs/api

Beispiel für die Login-Route:
https://meinefirma.dieagenturverwaltung.de/api/v2/auth/login

Um API-Routen erreichen zu können, musst du mit deinem Request einen Authorization-Token oder ein Cookie mitsenden.

Du kannst diese Token unter dieser Route mit deinen Zugangsdaten abrufen:

/api/v2/auth/login

Anschliessend sendest Du den sessionToken aus der Antwort dieser Anfrage im Header Authorization. Alternativ kannst du den Set-Cookie Header nutzen um das Cookie PHPSESSID für Browser-basierte Clients zu nutzen.

API-Glossar

API-Begriff	Bezeichnung in der Agenturverwaltung
Absence Additional Contingent	Abzüge & Zuschläge zum Urlaubskonto
Absence Contingent	Urlaubskontingent
Account	Etat
Accounting	Buchhaltungsexport
Accounting Contact	Personenkonten (Debitoren/Kreditoren)
Added Value	Wertschöpfung an KV-Positionen
Asset Account	Sachkonto-Vorschläge
Attachment	Datei-Anhang
Attendance	Anwesenheit
Auth	Login, Passwort vergessen, Logout
Bank Account	Bankverbindung an Adresskontakten
Catalog	Produkt- und Leistungskatalog
Commission	Provisionen
Contact	Adressbuch-Kontakte
Craft	Funktionen
Credit Invoice	Gutschriften
Creditor	Offene Posten Kreditoren
Custom Filter	Benutzerdefinierte Filter
Custom Report	Benutzerdefinierte Berichte
Customer	Kunden
CustomField	Benutzerdefinierte Felder
Dashboard	Dashboard
Debitor	Offene Posten Debitoren
Email	E-Mail
Employment Contract	Arbeitsverhältnis
Estimate	Kostenvoranschläge
Finance	Finanzdokumente allgemein
Finance Journal	Finanzdokumente allgemein
Finance Journal Positions	Finanzdokumentpositionen
FinDocCategory	Kosten- und Erlöskategorien
Forecast	Vorschaubericht
General	Allgemein
General Info	Unternehmensdaten
Holiday	Feiertage
Integrations	Integrationen
Invoice	Ausgangsrechnungen
Job	Projekte
Job Tasks	Projekt-Zeiten
Me	Infos zum angemeldeten Benutzer
Metrics	Kennzahlen
Office Location	Standorte
Order Confirmation	Auftragsbestätigungen
Organisation	Adressbuch-Kontakte von Organisationen
Payment	Zahlungen
Person	Adressbuch-Kontakte von Personen
Procedure	Aufgaben
Procedure View	Aufgabenansichten
Purchase Invoice	Eingangsrechnungen
Purchase Order	Lieferantenaufträge
Resource Planning	Kapazitätsplanung
Snippet	Textbausteine
Target	Ziele
Team	Teams
Template	Vorlagen
User	Benutzer
User Craft	Funktionen (der Zeiterfassung)
User Group	Benutzergruppen
User Group Actions	Berechtigungen in Benutzergruppen
User Group Users	Benutzer in Benutzergruppen
WorkPattern	Tätigkeiten der Zeiterfassung