3M alkalmazásprogramozási felület (API) – részletek
3M API-alkalmazások és az ügyfelekre érvényes használati feltételek
1. Bevezetés – a 3M és az ügyfél számára kötelező lépések
-
Kezdés: (kvalifikált ügyfelek számára)
- Orientáció
- Az API-król általánosságban
- Használati esetek
- Problémás területek áttekintése
- Alkalmazások kiválasztása
- A feltételek jogi és biztonsági jóváhagyása
-
Funkcionális felülvizsgálat:
- Az API-funkciók dokumentációja
- Kérelem- és válaszszerkezet
- Használatieset-minták
- GYIK
-
Tesztelési hozzáférés:
- Ügyfélazonosító és biztonsági token, illetve URL-ek átadása a teszteléshez
- 3M műszaki támogatás vagy adatminőség-ellenőrzések
-
Éles üzem:
- Az adatok vagy az alkalmazás éles indítása
- Igény szerint 3M műszaki támogatás
- A 3M monitorozza a folyamatos használatot vagy problémákat
2. Biztonság
- OAuth 2.0 a végfelhasználók hitelesítéséhez
- A hitelesítési URL-címet a 3M biztosítja
- Az URL-cím a minőségbiztosítás során és az éles üzemben eltérő, és a 3M biztosítja a megfelelő megvalósítási szakaszban
- Az ügyfélazonosítót és az ügyfél titkos kódját a 3M hozza létre, és adja át az API használójának
- Az ügyfélhitelesítő-adatok eltérőek lesznek a minőségbiztosítási és az éles üzem esetében, és a 3M biztosítja ezeket a megfelelő megvalósítási szakaszban
- A tokent tulajdonosi tokenként kell átadni a kérelem engedélyezési fejlécében
- A használathoz szükséges összes tokenizálást és konfigurációt a 3M biztosítja
- A hitelesítési URL-cím változhat; az esetleges módosításokról a 3M gondoskodik a hatályba lépés előtt
- Az ügyfélazonosító és a titkos ügyfélkód változhat; az esetleges módosításokról a 3M gondoskodik a hatályba lépés előtt
3. API-specifikációk
- Az API-átjáró RESTful API-ként van fejlesztve
- A kérés/válasz adatok JSON-ként vannak átadva a kliens és a szerver között
- A 3M által biztosított kérelem/válasz struktúra az egyes használt API-khoz
- A 3M által biztosított kötelező/opcionális attribútumok
- Hibakezelési forgatókönyvek (4xx, 5xx) bizonyos használt API-k esetén, amelyeket a 3M biztosít
- A 3M biztosít a megvalósítás során minden API-specifikus követelményt a klienstől (meghívó rendszertől)
- Az API URL-címe változhat; a 3M minden módosítást rendelkezésre bocsát a hatályba lépés előtt
4. 3M támogatás minden egyes API-hoz
- Igény esetén folyamatos támogatás az éles üzem során
- Az API-átjáró metrikáinak elemzése a használhatóság, a gyakoriság stb. tekintetében
- Közös visszatekintés az ügyféllel, hogy betekintést nyerhessen az API-val kapcsolatos általános elégedettségbe, a használatba, a problémákba és a bővítési kérésekbe
