REST API

• Was ist eine REST API?
• Schnittstellenbeschreibung
• Erstellen Sie einen REST-API Key
• Ein API-Key pro Projekt
• Kontaktdaten
• Zugriffsrechte
• Auf IP begrenzen
• Speichern, API-Key kopieren und nutzen
• Support zur REST-API

Was ist eine REST API?

Mit Hilfe der REST API-Keys können Sie programmatisch lesend und schreibend auf coveto zugreifen. Diese Art Schnittstelle ist für Ihren Entwickler interessant, kann aber auch von No-Code-Tools wie Zapier oder make genutzt werden.

Eine REST API (Representational State Transfer – Application Programming Interface) ist ein moderner Standard, um Software-Komponenten über das Internet miteinander kommunizieren zu lassen. Statt proprietärer Schnittstellen nutzt REST einfache HTTP-Methoden und klar definierte URL-Pfadstrukturen, um auf Datenressourcen zuzugreifen oder sie zu verändern.

Externe Partner, Mobile Apps und interne Services können ohne komplexe Bibliotheken oder Protokollkenntnisse angebunden werden. REST APIs sind der de-facto-Standard für verteilte Systeme, weil sie auf bewährten Web-Technologien aufsetzen, leicht verständlich sind und nahtlose Integrationen über verschiedene Plattformen hinweg ermöglichen. Ihr Unternehmen profitiert durch geringere Entwicklungskosten, schnelle Time-to-Market und hohe Flexibilität ihrer IT-Landschaft.

Schnittstellenbeschreibung

Die Schnittstellenbeschreibung steht Ihrem Entwickler als OpenAPI Version 3.1.0 Spezifikation direkt in coveto beim Anlegen eines API-Keys zum Download zur Verfügung. Verwenden Sie alternative diese öffentliche Version.

Für eine einfachere Darstellung nutzen Sie gerne diese Swagger UI.

Claude und ChatGPT sind in der Regel sehr gut darin, einen Beispiel-Code auf Basis der OpenAPI Spezifikation Datei (yaml) zu erstellen. Achtung: Bitte beachten Sie, dass Sie natürlich selbst die Verantwortung für die Korrektheit des Codes und die Ausführung tragen. KI kann Fehler machen.

Erstellen Sie einen REST-API Key

Ein API-Key pro Projekt

Für jede Software, Entwickler und Sicherheitsstufe empfehlen wir einen eigenen API-Key zu erstellen. Klicken Sie dazu unter Einstellungen » REST API auf Neu.

Kontaktdaten

Hinterlegen Sie die Kontaktdaten Ihres Entwicklers, damit wir ihn bei Sicherheitsvorfällen oder Überlastungen schnell und unbürokratisch unterstützen können.

Zugriffsrechte

Sie können für jeden API-Key festlegen, auf welche Endpunkte mit welchen Methoden zugegriffen werden darf. Verwenden Sie hier restriktive Zugriffsrechte und geben Sie nur die Endpunkte frei, die unbedingt nötig sind. Falls Ihr Entwickler zum Beispiel auf Jobs zugreifen soll, geben Sie keine Endpunkte frei, die Bewerberdaten beinhalten.

Sie können pro Endpunkt folgende Rechte vergeben:

Wert	HTTP Methoden	Beschreibung
none		Kein Zugriff auf diese Endpunkte.
read		Datensätze lesen.
write		Lesen, bearbeiten und neue Daten anlegen.
delete		Alle Rechte inklusive löschen.

Auf IP begrenzen

Grenzen Sie den Zugriff falls möglich noch auf die IP des Servers ein, der die API nutzen soll. Damit erhöhen Sie die Sicherheit noch weiter.

Speichern, API-Key kopieren und nutzen

Klicken Sie auf Speichern. Wichtig: Kopieren Sie nun den API-Key. Er wird verschlüsselt gespeichert und kann nur einmal angezeigt werden.

Geben Sie den API-Key und den Link zur OpenAPI Dokumentation an Ihren Entwickler weiter.

Support zur REST-API

Bitte beachten Sie, dass wir keinen Support zu externen Systemen oder Programmiersprachen anbieten können. Unser Support beschränkt sich ausschließlich auf auf die Bereitstellung unserer API.

• Da es vermutlich um technische Fragen geht, stellen Sie Ihre Support-Anfrage bitte schriftlich entweder direkt aus coveto (oben rechts auf ? » Support-Anfrage) oder senden Sie uns eine E-Mail an info@coveto.de.
• Geben Sie bitte die ID des API-Keys und die Kundennummer an.
  • Die ID finden Sie im API-Key selbst (coveto-{$id}-{hash}).
  • Die Kundennummer finden Sie in der URI der Endpoints (https://kxxxx…).
• Bei Anfragen per E-Mail sind wir aus datenschutzrechtlichen Gründen in unseren Antworten stärker eingeschränkt.