Migrering till ny utvecklarportal

Vad händer? 

Vi lanserar en ny utvecklarportal som blir det enda sättet att integrera mot Stratsys programmatiskt. De befintliga API:erna kommer att avvecklas enligt en tidplan som kommer att kommuniceras separat. När datum finns tillgängligt kommer vi att uppdatera artikeln med den informationen.

Vad innebär detta för er? 

Er befintliga integration mot Stratsys äldre API behöver skrivas om mot den nya utvecklarportalen. Nedan sammanfattar vi de viktigaste förändringarna: 

1. Ny OAuth2-klient medfinkornigabehörigheter (scopes) 

Den nya plattformen använder domänspecifika scopes istället för de breda behörigheter som fanns tidigare. Exempel på nya scopes: 

• kpi.read / kpi.readwrite 

• scorecard.read 

• organization.read / organization.readwrite 

• node.read / node.readwrite 

Ni behöver registrera en ny klient i vår utvecklarportal och tilldela exakt de scopes som er integration kräver. Detta för att säkerställa att er integration bara kan hämta den data ni är intresserade av. 

2. UppdateradeAPI-kontrakt
Vi har konsoliderat namngivningen i våra kontrakt för att skapa enhetlighet. Exempel på förändringar: 

• • ColumnId → ScorecardColumnId 

• • NodeIdentifierId → NodeId 

• • ExternalCode → ExternalId 

• • CustomField → DescriptionField 

3. Begränsning av anropsfrekvens (rate limiting) 
Det nya API:et har inbyggd hastighetsbegränsning per klient. Standardgränsen är 1 000 anrop per timme. Vid överskridande returneras HTTP 429 (Too Many Requests).  

4. Versionering
API:etfinns i version 1 (v1) med full funktionalitet. Vissa domäner erbjuder även v2-endpoints med uppdaterade responsformat. Alla anrop går via basvägen /v1/ respektive /v2/. Finns en v2 endpoint som fyller ert behov bör dessa användas. 

 5. Nya HTTP-headers

Vissa endpointskräver nya headers: 

• • Stratsys-Version – ange Active eller Planning för att välja version 

• • Stratsys-ExternalSource – krävs vid användning av externa ID-mappningar 

Utvecklarportal och dokumentation 

All dokumentation, interaktiv API-utforskning och OAuth2 konfiguration finns samlad i vår nya utvecklarportal. Där hittar ni: 

• Komplett Swagger/OpenAPI-dokumentation för samtliga endpoints 

• Interaktiv testmiljö (Scalar) för att prova anrop direkt i webbläsaren 

• Guider för autentisering och scope-konfiguration 

• Kontraktsbeskrivningar per domän (Scorecards, KPI:er, Organisation, Noder, Rapporter m.fl.) 

Vad behöver ni göra? 

Besök vår utvecklarportal för: 

• fullständig dokumentation 

• interaktiv API-testning 

• guider för autentisering och migrering

Ni når utvecklarportalen enklast via Stratsys plattform:

Så här ser det ut i plattformen:

FAQ

Vem hos oss bör läsa den här informationen?

Informationen bör delas med den eller de personer som ansvarar för era integrationer mot Stratsys. Det kan exempelvis vara en intern IT-avdelning, en integrationspartner eller en systemleverantör.

Vad bör vi göra först?

Börja med att identifiera vilka av era nuvarande integrationer som använder Stratsys äldre API:er. Därefter bör ni gå igenom dokumentationen i utvecklarportalen, skapa en ny OAuth2-klient och planera hur integrationen ska anpassas till de nya API-kontrakten.

Vad händer om vi inte uppdaterar vår integration?

Om integrationen inte anpassas innan de äldre API:erna avvecklas finns risk att integrationen slutar fungera. Därför rekommenderar vi att ni går igenom er nuvarande integration och planerar migreringen i god tid.

Vad är den största skillnaden mot tidigare API:er?

Den nya plattformen använder OAuth2-klienter med mer detaljerade behörigheter, så kallade scopes. Det innebär att integrationen bara får åtkomst till de områden och den data som den faktiskt behöver.

Hur vet jag vilka av våra integrationer som påverkas?

Stratsys kan inte på ett enkelt sätt veta vilka integrationer ni har då ni har möjlighet att själva bygga API-integrationer. Vi sköter inte integrationsdokumentationen åt er som kunder. Är ni osäkra på vilken integration ni har som berörs kan vi hjälpa er se vilka anrop som görs och med vilket klient-id. Vid behov av stöttning, vänd er till Stratsys support.