3M Application Programming Interface (API) Details
3M API-Anwendungen und Kunden-Nutzungsbedingungen
1. Onboarding – Schritte die von 3M und dem Kunden erforderlich sind
-
Einführung: (für qualifizierte Kunden)
- Überblick
- API-Landschaft
- Anwendungsfälle
- Problembewertung
- Anwendungsauswahl
- Rechtliche und sicherheitstechnische Zustimmung zu den Bedingungen
-
Funktionale Überprüfung:
- Dokumentation der API-Funktionalität
- Antrag und Antwortstruktur
- Anwendungsfallbeispiele
- FAQs
-
Testzugang:
- Client-ID und Sicherheits-Token sowie URLs für Tests bereitstellen
- 3M Technischer Support oder Datenqualitätsprüfungen
-
Produktion:
- Live-Einführung von Daten oder Anwendungen
- Technische Unterstützung von 3M nach Bedarf
- 3M wird die weitere Nutzung oder Probleme überwachen
2. Sicherheit
- OAuth 2.0 für die Authentifizierung von Endnutzern
- Authentifizierungs-URL wird von 3M bereitgestellt
- Die URL wird für QA und PROD unterschiedlich sein und wird von 3M in der entsprechenden Implementierungsphase bereitgestellt.
- Client-ID und Client-Secret werden von 3M erstellt und dem API-Nutzer zur Verfügung gestellt
- Die Client-Anmeldedaten sind für QA und PROD unterschiedlich und werden von 3M in der entsprechenden Implementierungsphase bereitgestellt.
- Token wird als Bearer Token im Autorisierungskopf der Anfrage bereitgestellt.
- Alle Tokenisierungen und Konfigurationen für die Nutzung werden von 3M bereitgestellt.
- Die Authentifizierungs-URL kann sich ändern. Änderungen werden von 3M vor ihrem Inkrafttreten bekannt gegeben.
- Client-ID und Client secret können sich ändern. Änderungen werden von 3M vor ihrem Inkrafttreten mitgeteilt.
3. API-Spezifikationen
- API-Gateway als RESTful API erstellt
- Anfrage-/Antwortdaten, die als JSON zwischen Client und Server übertragen werden
- Die Anforderungs/Antwort-Struktur für bestimmte APIs, die genutzt werden, wird von 3M bereitgestellt.
- Obligatorische/optionale Attribute, die von 3M bereitzustellen sind
- Fehlerbehandlungsszenarien (4xx, 5xx) für bestimmte APIs, die genutzt werden, werden von 3M bereitgestellt.
- Alle API-spezifischen Anforderungen des Kunden (aufrufendes System) werden von 3M während der Implementierung bereitgestellt.
- Die API-URL kann sich ändern. Änderungen werden von 3M vor ihrem Inkrafttreten bekannt gegeben.
4. 3M-Unterstützung für jedes API
- Bei Bedarf Bereitstellung von kontinuierlicher PROD-Unterstützung
- Analysieren von API-Gateway-Metriken zu Benutzerfreundlichkeit, Häufigkeit usw.
- Durchführung einer Retrospektive mit dem Kunden, um Einblicke in die allgemeine API-Zufriedenheit, Nutzung, Probleme und Verbesserungsvorschläge zu erhalten
