3M Application Programming Interface (API) details
3M API toepassingen en gebruiksvoorwaarden voor klanten
1. Opstartprocedure — benodigde stappen voor 3M en de klant
-
Intake: (voor gekwalificeerde klanten)
- Kennismaking
- API overzicht
- Voorbeeldsituaties
- Het nalopen van de uitdagingen
- Selectie van toepassingen
- Juridische en beveiligingsgoedkeuring van de voorwaarden
-
Functionele analyse:
- Documentatie over API functionaliteit
- Verzoek- en antwoordstructuur
- Voorbeelden van situaties
- Veelgestelde vragen
-
Testen van de toegang:
- Verstrek klantnummer en beveiligingstoken, URL's voor testen
- 3M technische ondersteuning of kwaliteitsanalyse van gegevens
-
Productie:
- Live lancering van gegevens of applicatie
- Benodigde 3M technische ondersteuning
- 3M houdt continue toezicht op gebruik of problemen
2. Beveiliging
- OAuth 2.0 voor verificatie van eindgebruiker
- Verificatie URL wordt verstrekt door 3M
- De URL is voor QA en PROD verschillend en worden door 3M verstrekt tijdens de implementatiefase
- Client-ID en clientgeheim worden door 3M aangemaakt en aan de API-consument verstrekt
- De klant inloggegevens zijn voor QA en PROD verschillend en worden door 3M verstrekt tijdens de implementatiefase
- Token moet als bearer token worden doorgegeven in de autorisatieheader van de aanvraag
- Alle tokenisatie en configuraties voor gebruik worden geleverd door 3M
- De verificatie-URL kan worden gewijzigd. Eventuele wijzigingen worden door 3M gedeeld voordat ze van kracht worden
- Client-ID en -geheim kunnen worden gewijzigd. Eventuele wijzigingen worden door 3M verstrekt voordat ze van kracht worden
3. API specificaties
- API gateway gebouwd als RESTful API
- Aanvraag / antwoord informatie worden als JSON tussen klant en server doorgegeven
- Aanvraag /antwoordstructuur voor specifiek gebruikte API's, wordt verstrekt door 3M
- Verplichte/optionele attributen worden verstrekt door 3M
- Foutmeldingen (4xx, 5xx) voor specifieke API's die worden gebruikt, worden verstrekt door 3M
- Alle API-specifieke vereisten van de client (oproepsysteem) worden door 3M verstrekt tijdens de implementatie
- API URL is onderhevig aan wijzigingen. Eventuele wijzigingen worden door 3M verstrekt voordat ze van kracht worden
4. 3M ondersteuning voor elke API
- Bied indien nodig continue PROD-ondersteuning
- Analyseer API Gateway statistieken op het gebied van bruikbaarheid, frequentie, enz.
- Terugkijken met de klant om inzicht te krijgen in de algemene API tevredenheid, het gebruik, problemen en verzoeken om verbeteringen door te voeren
