REST-APIs sind Programmier-Schnittstellen, über die Software-Systeme miteinander verbunden werden können.
Wir beschreiben Schnittstellen, die eine REST-API einer Anwendung mit
• einer anderen REST-API,
• einem in das Dateisystem eingebundenen Cloud-Speicher oder
• einer über das Netzwerk erreichbaren Datenbank
verbinden.
Zu den Produkteigenschaften ↓ Zur Bestellung ↓
Ihr Vorhaben wird planbarer und die Kosten kalkulierbarer. Sie können mehrere Angebote für die Umsetzung anfordern und womöglich Kosten sparen.
Das Risiko eines Scheiterns wird reduziert. Beginnen Sie die Umsetzung ohne eine belastbare Beschreibung, wäre das Risiko größer, ein wichtiges Detail übersehen zu haben. Letztendlich könnte Ihr Projekt dadurch scheitern.
Die Sicherheit der Schnittstelle wird erhöht. Die Beschreibung geht auch auf Sicherheitsaspekte ein, beispielsweise Autorisierung anderer Systemkomponenten, die auf die beschriebene Schnittstelle zugreifen.
Verständliche und vollständige englisch- oder deutschsprachige Dokumentationen der API bzw. der APIs sind öffentlich und kostenfrei verfügbar oder werden entsprechend bereitgestellt.
Alle Inhalte der Beschreibung werden in einer für einen sachkundigen Leser verständlichen Kurzform erstellt. Die Beschreibung wird einen angemessenen Umfang haben, der es einem Anwendungsentwickler mit den notwendigen Fachkenntnissen ermöglicht, mit der Realisierung zu beginnen und Detailfragen selbstständig zu klären.
Wir stellen Ihnen die Schnittstellenbeschreibung innerhalb einer Woche nach Klärung der Anforderungen bereit.
Sollten wir für die Beschreibung der Schnittstelle Zugriff auf personenbezogene Daten erhalten müssen, benötigen wir gemäß DSGVO einen Auftragsverarbeitungsvertrag (AVV) mit Ihnen. Sie erhalten in diesem Fall unverzüglich einen solchen Vertrag. Änderungswünsche Ihrerseits berücksichtigen wir gerne. Vor einer Bestätigung des AVV Ihrerseits oder dem Abschluss eines anderen AVV geschieht die Auftragsverarbeitung nur nach den Regelungen des von uns bereitgestellten AVV.
Wir gehen davon aus, dass Basisanforderungen wie der Zweck und eine grobe Übersicht zu den gewünschten Funktionen bei Ihnen intern bereits geklärt wurden.
Da Schnittstellen und deren Beschreibungen sehr komplex sein können, schränken wir die Komplexität für jede der Produktvarianten ein. REST-APIs greifen über das HTTP-Protokoll mit Methoden wie GET, PUT, POST und DELETE auf Ressourcen zu. Beispiele für Ressourcen sind unter anderem Kunde, Lieferant, Lagerbestand, Dokument, Rechnung und Bestellung. Die Anzahl unterschiedlicher Ressourcen, die über die API bzw. die APIs angesprochen wird, nehmen wir als Unterscheidungsmerkmal für die Komplexität der einzelnen Produktvarianten.
Ein ggf. beteiligter und im Zusammenhang mit einer verwendeten REST-API stehender Cloud-Speicher muss in das Dateisystem eingebunden werden können. Die Zugriffe werden auf Ressourcenebene beschrieben (s. auch Komplexität der Schnittstelle).
Eine ggf. beteiligte und im Zusammenhang mit einer verwendeten REST-API stehenden Datenbank muss über das Netzwerk erreichbar sein. Die Zugriffe werden auf Ressourcenebene beschrieben (s. auch Komplexität der Schnittstelle).
Spätestens am nächsten Werktag nach Ihrer Bestellung erhalten Sie per E-Mail Vorschläge für zeitnahe Termine zur Auswahl. In dem etwa 60 Minuten dauernden Online-Meeting besprechen wir Ihre Anforderungen.
Ein fachkundiger Ansprechpartner wird vom Auftraggeber benannt und steht für Fragen in angemessenem Umfang zur Verfügung.
Die Beschreibung wird als PDF-Dokument erstellt.
Sie erhalten an der Schnittstellenbeschreibung ein einfaches Nutzungsrecht. Sie dürfen Kopien zum privaten Gebrauch oder zum Einsatz in Ihrem Unternehmen erstellen. Eine Weitergabe ist nur zum privaten Gebrauch, innerhalb Ihres und verbundener Unternehmen sowie an Geschäftspartner zulässig. Eine Veröffentlichung ist nicht gestattet. Änderungen dürfen, sofern diese als solche gekennzeichnet sind, vorgenommen werden.
Eine Übersicht der beteiligten Systeme wird gegeben.
Beschreibung des Zwecks der Schnittstelle.
Zeitpunkte an denen eine Datenübertragung stattfindet bzw. die Ereignisse, die eine Datenübertragung auslösen.
Notwendige Maßnahmen zur Konvertierung von Daten.
Übersicht der für den Betrieb notwendigen Komponenten sowie die entsprechenden Zuständigkeiten.
Autorisierung von Zugriffen auf die Schnittstelle. Einsatz von Verschlüsselung.
Aufzählung der Ressourcen, Endpunkte und jeweils verwendeten Methoden zum Zugriff auf die API bzw. die APIs.
Datenmengen, Datentypen und Format je Endpunkt und Methode.
Übersicht zu den Wartungsaufgaben.
Übersicht der notwendigen Datenbankzugriffe. Je Zugriff wird dessen Art (Lesen, Schreiben, ...) sowie die betroffene Ressource angegeben. Die einzelnen Datenfelder werden nicht aufgezählt.
Übersicht der notwendigen Zugriffe auf die Dateien des im Dateisystem eingebundenen Cloud-Speichers. Je Zugriff wird dessen Art (Lesen, Schreiben, ...) sowie die betroffene Ressource angegeben. Die einzelnen Datenfelder werden nicht aufgezählt.
Erkennung von Fehlersituationen und entsprechende Maßnahmen.
Angaben zur Überwachung des Betriebs der Schnittstelle.
Nachfolgende Preise verstehen sich als Einmalzahlung inkl. der gesetzlichen Umsatzsteuer. Keine Versandkosten. Bei Klick auf einen der weiter unten stehenden Bestellbuttons werden Sie an Digistore24 weitergeleitet.
Nehmen Sie Kontakt mit uns auf, wenn Sie sich nicht sicher sind, welche Variante auf Ihre Anforderungen passt oder Sie die Beschreibung einer besonders komplexen Schnittstelle benötigen.
Über die REST-API eines Warenwirtschaftssystems werden Lagerbestände und Produktdaten gelesen und und über die REST-API eines Auftragsbearbeitungssystems mit diesem synchronisiert. Es sind 2 Ressourcen beteiligt.
Über die REST-API eines Dokumentenmanagementsystems werden Rechnungen und dazugehörige Lieferscheine gelesen und und über die REST-API eines Buchhaltungssystems an dieses gesendet. Im Buchhaltungssystem erstellte Buchungsjournale werden an das DMS gesendet und dort archiviert. Es sind 3 Ressourcen beteiligt.
Über die REST-API eines Shop-Systems werden Daten zu Bestellungen, Kunden, Produkten, Lieferungen und Rechnungen abgerufen und über die REST-API eines Dokumentenmanagementsystems archiviert. Es sind 5 Ressourcen beteiligt.
Wir bieten außer der Beschreibung von Schnittstellen auch andere Dienstleistungen, z. B. IT-Beratung zum Thema der Digitalisierung im Bürobetrieb, sowie weitere Produkte an.
Nutzen Sie unser Kontaktformular, schreiben Sie uns eine E-Mail oder rufen Sie uns an!
040 228692950
oder
info@advernet.de
(Informationen zu E-Mail-Verschlüsselung)