Einführung in die Ninox API

Lerne, was die Ninox API macht, wie sie funktioniert und welche Kernressourcen sie bereitstellt.

Die Ninox API ist eine öffentliche Schnittstelle. Damit greifst du programmatisch auf Ninox Apps zu.

Sie ermöglicht externen Apps, Diensten und Skripten, sicher auf Daten in Ninox zuzugreifen, sie zu lesen und zu ändern.

Mit der API ist Ninox mehr als eine eigenständige Plattform. Deine Daten können zwischen Systemen fließen.

Moderne Workflows laufen selten in nur einem Tool. Teams nutzen mehrere Plattformen für Automatisierung, Analyse, Kommunikation und operative Prozesse. Die Ninox API ist dafür ausgelegt, die Integration mit diesen Tools einfach und flexibel zu machen.

Was du mit der Ninox API machen kannst

• Wiederkehrende Aufgaben automatisieren

• Eigene Lösungen programmatisch entwickeln

• Die Migration zu Ninox 4 vereinfachen

Mit der Ninox API kannst du:

• CRUD-Operationen für Module ausführen

• CRUD-Operationen für Tabellen ausführen

• CRUD-Operationen für Felder einzeln oder im Batch ausführen

• CRUD-Operationen für Datensätze einzeln oder im Batch ausführen

• CSV-Daten mit append, update und upsert importieren

• Arbeitsbereich-Informationen abrufen

Was du als Entwickler wissen solltest

Das sind die wichtigsten Erwartungen an die Arbeit mit der API:

• Die API ist ressourcenorientiert. Die Kernressourcen sind Module, Tabellen, Felder, Datensätze und Arbeitsbereiche.

• Anfragen werden über HTTPS gesendet und nutzen JSON-Payloads.

• Die API nutzt Standard-HTTP-Methoden wie GET, POST, PATCH und DELETE.

• Die Authentifizierung nutzt einen API-Key des Arbeitsbereichs im HTTP-Header.

• Jeder API-Key ist auf genau einen Arbeitsbereich begrenzt.

• Einige Feld- und Datensatz-Operationen unterstützen Batch-Requests.

• Die API ist über Swagger sowie als OpenAPI in JSON- und YAML-Format verfügbar.

So funktioniert die Ninox API

Die Ninox API folgt einer RESTful-Architektur und kommuniziert über HTTPS. Das bedeutet:

• Anfragen gehen an bestimmte Endpunkte.

• Daten werden in einem strukturierten Format ausgetauscht, meist JSON.

• Standard-HTTP-Methoden werden verwendet: GET, POST, PATCH, DELETE.

Für alle Anfragen ist ein API-Key des Arbeitsbereichs im HTTP-Header erforderlich. Du kannst API-Keys im Screen Ninox API und Integrationen in Ninox erstellen und verwalten.

Jeder API-Key ist mit einem bestimmten Arbeitsbereich verknüpft und gibt nur Zugriff auf Daten in diesem Arbeitsbereich.

Die Endpunkte der Ninox API findest du in einer Swagger-Instanz unter https://go.ninox.com/api/docs.

Die OpenAPI-Spezifikation kannst du auch unter https://go.ninox.com/api/docs-json oder https://go.ninox.com/api/docs-yaml abrufen.