API-katalogen

Det är viktigt att användarna av API-katalogen lätt kan se vilka subsystem som innehåller gränssnittstjänster som kan utnyttjas via Suomi.fi-informationsleden och vilka som inte gör det. 

Beskriv din organisations subsystem som utnyttjar tjänster via Informationsleden i API-katalogen så att det tydligt framgår av beskrivningen att subsystemet inte tillhandahåller tjänster. 

Du kan använda följande mening: "Subsystemet erbjuder inte tjänster, utan utnyttjar endast information som fås via Suomi.fi-informationsleden."

Tjänsterna kan tas i bruk genom att avtala om det med tjänsteleverantören. Observera att ibruktagningsprocesserna av tjänster är alla olika och kräver olika avtal och tillstånd. Alla organisationer som anslutit sig till Suomi.fi-informationsledens produktionsmiljö och beskrivningar av organisationernas tjänster finns i API-katalogenÖppnas i ett nytt fönster..

Läs mer om ibruktagandet av tjänster som erbjuds via Informationsleden i stödartikeln.

Det kan man inte göra. Information av en organisations behörigheter är synliga endast till de anslutningsservrar som utnyttjar eller erbjuder just den tjänsten. Informationsledens centralserver har inte åtkomst till denna information.

Om din tjänst inte visas alls i API-katalogen på subsystemets sida, bör du kontrollera minnesinställningarna för anslutningsserverns Proxy- och Signer-processer.

För instruktioner om hur du kontrollerar och ändrar minnesinställningar, se supportartikeln om ämnet.

Din tjänst visas som okänd i API-katalogen om den saknar gränssnittsbeskrivning i anslutningsserverns administration användargränssnitt på Informationsleden. Utan gränssnittsbeskrivning kan API-katalogen inte identifiera om din tjänst har formatet REST eller SOAP.

En okänd tjänst är oftast en REST-tjänst som lagts till i Informationsled i formatet REST API base path. API-katalogen identifierar inte REST-tjänster som lagts till med REST API Base Path. Gränssnittsbeskrivningen ska ha formatet OpenAPI 3 för att API-katalogen ska kunna visa den.

Vi rekommenderar att du lägger till REST-tjänster med stigen OpenAPI 3 Description i Informationsleden för att API-katalogen ska kunna identifiera tjänsten och automatiskt visa gränssnittsbeskrivningen.

I vissa fall kan SOAP-tjänsten förlora WSDL-beskrivningen och då syns även den som en okänd tjänst.

Läs mer om den tekniska beskrivningen av tjänsterna i supportartikeln.

Du får användarnamn till tjänsten genom att kontakta Informationsledens stödadress palveluvayla@palveluvayla.fi.