API Explorer

Produktdokumentation beskriver möjligheter. Explorern beskriver er miljö.

Utgå från er egen miljö när ni väljer API. Konfiguration, moduler, behörigheter och lokala tillägg behöver finnas med i planeringen.

Ett uttag ur API Explorer gör designdiskussionen konkret, och det utan att först anta att produktdokumentationen beskriver just er miljö.

OpenAPI för verktyg, OData för modell och körning

API Explorer visar mer än en läsbar beskrivning. För en vald projection eller OData-tjänst kan ni öppna OpenAPI v2, OpenAPI v3 och OData Service Document. Spara det format som ert verktyg använder, men spara också release och miljö; en specifikation från dokumentationen är inte ett bevis på att samma tjänst är aktiverad hos er.

IFS beskriver OAuth2 som normal autentisering. Spara integrationsidentitetens autentiseringsflöde och åtkomst tillsammans med API-klass och de entity sets ni använder.

Kontrollerad mot Navigating through API Explorer (25R2) · 2026-10-03

Specifikationen är ett underlag, inte en engångsvy

Eftersom specifikationerna går att hämta i standardformat är de jämförbara över tid. Det gör en enkel rutin ovanligt värdefull:

1. Hämta specifikationen för de API:er ni faktiskt använder.
2. Spara den versionerat, tillsammans med release och datum.
3. Hämta om efter varje uppgradering och jämför.

En diff hjälper er att hitta delar som behöver granskas. Kombinera den med provkörningar av de affärsfall som integrationen använder.

Entity Services

API Explorer listar också Entity Services. Dokumentationen kan visas även när tjänsten är inaktiv. Kontrollera aktivering och åtkomst innan ni planerar ett anrop.

Kontrollerad mot Navigating through API Explorer (25R2) · 2026-10-03

Vad betyder API Class, Layer och Deprecated?

API Class

Beskriver IFS avsedda ansvar för API:et över tid. Premium och Standard har olika förväntningar på dokumentation och vägledning vid förändring.

Layer

Visar om projektionen hör till Core, Customization eller Configuration.

Deprecated

Markerar ett API som planeras för borttagning i en framtida release. Markeringen anger inte ensam när ert flöde behöver byta API.

Kontrollerad mot Navigating through API Explorer (25R2) · 2026-10-03

IFS API-policy beskriver ambitionen att bevara kompatibilitet för Premium API:er och ge vägledning när ändringar behövs. Förväntningarna gäller core-lagret; anpassade eller konfigurerade API:er är kundens ansvar. Läs därför klass och lager tillsammans och prova era egna tillägg.

Kontrollerad mot API Usage – IFS Cloud (IFS Cloud (policy)) · 2026-10-03

Vårt förslag är att ge varje deprecated beroende en ansvarig och ett nästa steg: hitta rekommenderad ersättare, kontrollera fält och felhantering, och prova det berörda flödet. Lägg planeringen bredvid releaseunderlaget.

Så kontrollerar ni API-kontraktet före en uppgradering

Spara ett uttag före förändringen och ett från målmiljön. Jämför de delar era integrationer använder. En specifikationsdiff visar strukturella skillnader; provkörningen visar hur åtkomst, data och verksamhetsregler fungerar tillsammans.

Tabellen är en redaktionell kontrollista. Anpassa testdata och godkännandekriterier efter ert flöde.

Spara request, maskerat svar, förväntat resultat och faktiskt utfall tillsammans. Då blir ett misslyckat test lättare att följa upp även för den som inte deltog i provet. Felkoder och svarskroppar beskrivs i OData-guidens felsökning.

Hämta kontrollista för API-release (Markdown)

Ett fält finns kvar, men klienten behöver ändras

Tänk er ett flöde som läser ett saldo till ett lager. Följande utdrag är påhittade kontraktsexempel; fältnamnen representerar ingen IFS-projektion och ingen verklig releaseändring.

Tidigare svar i exemplet:

{ "ExempelId": "ART-TEST", "ExempelSaldo": 12 }

Målmiljöns svar i exemplet:

{ "ExempelId": "ART-TEST", "ExempelSaldo": "12" }

Fältnamnet är oförändrat, men värdet är nu en sträng. En klient som kräver ett numeriskt värde kan avvisa svaret. Kontrollera därför både fälttypen i specifikationen och den kod som läser svaret.

Skriv fyndet konkret: ”Saldo måste fortfarande kunna läsas som ett tal av lagrets klient.” Koppla det till parsningstestet och låt flödets ägare godkänna korrigeringen. Lägg en borttagen operation eller ett nytt obligatoriskt indatafält på egna rader; de behöver andra åtgärder än en typändring.

Vanliga frågor om IFS API Explorer

Varför går en Entity Service att se men inte använda?

IFS dokumenterar att Entity Services är inaktiva från början och behöver aktiveras av en administratör för CRUD-operationer. Specifikationen kan ändå visas. Kontrollera aktivering och åtkomst med miljöns administratör; tjänster för inaktiva moduler listas inte.

Vad gör vi när API Doc inte orkar visa specifikationen?

IFS beskriver att stora specifikationer kan göra den inbyggda vyn instabil. Öppna eller hämta OpenAPI-filen direkt och använd en texteditor eller en annan OpenAPI-visare.

Kontrollerad mot Navigating through API Explorer (25R2) · 2026-10-03

Räcker en diff för att godkänna uppgraderingen?

Vårt råd är att använda diffen för att välja vad som ska provas. Kör också samma affärsfall med integrationsidentiteten i målmiljön. Behörigheter, testdata och verksamhetsregler behöver ingå i godkännandet.

Fortsätt med planeringen från Apps 10 till IFS Cloud när ni har samlat kontrakt och öppna frågor.