Installation und Updates > AddOne.API > Nutzung

Mit der AddOne.API können Sie auf Daten Ihres AddOne-Systems zugreifen und diese – abhängig von den vergebenen Berechtigungen – lesen oder bearbeiten.

Dieser Artikel richtet sich an Entwickler und IT-Administratoren, die bereits grundlegende Kenntnisse im Umgang mit REST- oder GraphQL-Schnittstellen besitzen und ihre erste Verbindung zur AddOne.API herstellen möchten.

Voraussetzungen

Bevor Sie beginnen, stellen Sie sicher, dass folgende Voraussetzungen erfüllt sind:

•Die AddOne.API wurde erfolgreich installiert.

•Die API ist über das Netzwerk erreichbar.

•Sie verfügen über einen gültigen API-Key.

•Die Basis-URL der API ist bekannt.

•Die Nummer des gewünschten AddOne-Mandanten ist bekannt.

Aufbau einer API-Adresse

Eine API-Adresse setzt sich aus mehreren Bestandteilen zusammen.

https://<Server>:<Port>/api/mandanten/<Mandant>/<Modul>/graphql

Beispiel:

https://server:5000/api/mandanten/1/stammdaten/graphql

Die einzelnen Bestandteile haben folgende Bedeutung:

Bestandteil	Beschreibung
Server	Name oder IP-Adresse des Servers
Port	Port der API (z. B. 5000)
Mandant	Nummer des gewünschten AddOne-Mandanten
Modul	Fachmodul, z. B. stammdaten oder faktura

Authentifizierung

Die Authentifizierung erfolgt über einen API-Key.

Der API-Key wird als HTTP-Header übergeben.

X-AddOne-Api-Key: <Ihr API-Key>

Ohne einen gültigen API-Key können keine Daten abgefragt werden.

Erste Abfrage

Nach erfolgreicher Verbindung können Sie Ihre erste GraphQL-Abfrage ausführen.

query {
steuerschluessel {
id
bezeichnung
}
}

Eine erfolgreiche Antwort sieht beispielsweise wie folgt aus:

{
"data": {
"steuerschluessel": [
{
"id": 1,
"bezeichnung": "19 % MwSt."
}
]
}
}

Module

Die AddOne.API ist in verschiedene Fachmodule unterteilt.

Je nach gewünschtem Datenbereich wird ein entsprechendes Modul angesprochen.

Beispiele:

•Stammdaten

•Faktura

•Angebotswesen

•Dokumente

•Lagerwesen

•Personalverwaltung

Jedes Modul besitzt einen eigenen GraphQL-Endpunkt.

Nächste Schritte

Nachdem die Verbindung erfolgreich hergestellt wurde, können Sie die verfügbaren Abfragen und Datenstrukturen des jeweiligen Moduls erkunden.

Weitere Informationen finden Sie im Artikel API-Dokumentation verwenden.