3M Application Programming Interface (API) Details
3M API applications and Customer Terms of Use
1. Onboarding — 3M and Customer required steps
-
Kickoff: (for qualified customers)
- Przegląd
- Ekosystem API
- Przypadki użycia
- Przegląd problemów
- Wybór aplikacji
- Podpisanie zgody w zakresie aspektów prawnych i bezpieczeństwa
-
Functional Review:
- Dokumentacja funkcjonalności API
- Struktura żądań i odpowiedzi
- Przykładowe przypadki użycia
- Często zadawane pytania
-
Testing Access:
- Udostępnienie identyfikatora klienta, tokenu bezpieczeństwa i adresów URL do testowania
- Wsparcie techniczne 3M lub kontrola jakości danych
-
Production:
- Wdrożenie danych lub aplikacji do zastosowania „na żywo”
- Wsparcie techniczne 3M w zależności od potrzeb
- Firma 3M będzie monitorować dalsze zastosowanie lub problemy
2. Security
- OAuth 2.0 do uwierzytelniania użytkownika końcowego
- Adres URL uwierzytelniania, udostępniany przez 3M
- QA i PROD otrzymują od 3M różne adresy URL na odpowiednim etapie wdrażania.
- 3M tworzy tajny klucz i identyfikator klienta, które przekazuje użytkownikowi API.
- QA i PROD otrzymują od 3M różne dane uwierzytelniające na odpowiednim etapie wdrażania.
- Token jest przesyłany w formie nagłówka autoryzacji żądania z wartością Bearer.
- Wszystkie konfiguracje i tokeny niezbędne do użycia zapewnia 3M.
- Adres URL uwierzytelniania może ulec zmianie. O wszelkich zmianach 3M poinformuje przed ich wejściem w życie.
- Tajny klucz i identyfikator klienta mogą ulec zmianie. O wszelkich zmianach 3M poinformuje przed ich wejściem w życie.
3. API Specifications
- API Gateway zbudowana jako RESTful API
- Dane żądania/odpowiedzi są przesyłane między klientem a serwerem w formacie JSON.
- Struktura żądań/odpowiedzi dla konkretnych używanych API jest dostarczana przez 3M.
- Obowiązkowe/opcjonalne atrybuty są udostępniane przez 3M.
- Scenariusze obsługi błędów (4xx, 5xx) dla konkretnych używanych API są dostarczane przez 3M.
- Wszystkie wymagania klienta dotyczące API (system wywołujący) będą realizowane przez 3M na etapie wdrażania.
- Adres URL API może ulec zmianie. O wszelkich zmianach 3M poinformuje przed ich wejściem w życie.
4. 3M support for each API
- W razie potrzeby zapewnienie ciągłego wsparcia PROD.
- Analiza metryk API Gateway pod kątem użyteczności, częstotliwości wywołań itp.
- Przeprowadzenie spotkania retrospektywnego z klientem w celu uzyskania opinii na temat API (stopień zadowolenia, użycie, problemy, propozycje ulepszeń).
