Gränssnitt

Filtransport v3 har ett JSON-baserat gränssnitt över HTTP med TLS. För att integrera med tjänsten används HTTP POST, PUT samt GET med URL-parametrar och -värden.

Vid testning av HTTP-gränssnitt (som Filtransport) används ofta cURL. Exempel på cURL anrop mot Filtransport finns i menyn under Testa filtransport.

Dokumentation

Gränssnittet, se filtransport-v3.yaml, är beskrivet med hjälp av OpenAPI version 3.0.3. Det finns många olika verktyg för att visualisera filen eller generera kod utifrån den.

För mer information om OpenAPI, se OpenAPI-specifikationen.

Lämna fil

Lämning av fil görs som HTTP POST med Content-Type “multipart/form-data”, enligt RFC 2388.

För korrekt hantering av stora filer, rekommenderas att alltid sätta HTTP-header “Transfer‑Encoding: chunked”. För mer info om krav på filnamn och komprimering av filer, se fliken Filer i menyn.

Vid problem av uppladdning av filer större än 4kB men inte filer som är mindre, pröva lägga till HTTP-header “Expect: 100-continue”.

Utifrån den lämnade filen skapar SPAR en utfil som måste hämtas inom 60 dagar från det att filen skapades.

Verifiering av infil

När en infil lämnas in i SPAR-tjänsten verifieras att filen har rätt format i enlighet med XML-schemat. Det innebär dock inte att de personnummer som finns i filen ger träffar i SPAR, utan endast att de är korrekta på så sätt att de innehåller godkända siffror.

Begränsningar

Filer som lämnas i SPAR-tjänster via pgm-pgm får inte vara större än 100 Mbyte. Filer kan lämnas i zip-format. Alla utfiler levereras i zip-format.

Felkoder

Följande felkoder kan uppstå vid misslyckade anrop:

• Client.OgiltigInParameter: En eller flera paramterar i URL-anropet är inkorrekta.
• Client.HTTPfel: Någon del i anropet är felaktigt, t.ex. att operation POST används när det bör vara GET.
• Client.EjUppdrag: Angiven kund är ej behörig för angivet uppdrag.
• Client.EjFilHant: Angiven kund är ej registrerad som fillämnare eller filhämtare för angivet uppdrag.
• Server: Ett internt fel har uppstått. Försök igen senare eller kontakta kundtjänst.