• No results found

UC Direkt API V Guidelines för utvecklare

N/A
N/A
Protected

Academic year: 2022

Share "UC Direkt API V Guidelines för utvecklare"

Copied!
15
0
0

Loading.... (view fulltext now)

Full text

(1)

V. 2015.12.14

Guidelines för utvecklare

(2)

Innehåll

... 1

Innehåll ... 2

Introduktion ... 3

UC Direkt API ... 3

Generellt för alla anrop ... 3

API endpoints ... 4

Anrop ... 5

Felmeddelanden ... 6

Säkerhet ... 6

Tvåfaktorsautentisering ... 6

Hantera API-nycklar ... 7

Klientcertifikat ... 7

Testa er integration ... 7

Testmiljö ... 7

Testobjekt ... 7

Kontaktinformation ... 7

(3)

Introduktion

UC Direkt API levererar rapporter på ett enkelt och smidigt sätt.

Tjänsten är anpassad till företag med behov av snabba, enkla och tydliga besked. Förutom fullständiga kreditupplysningar på svenska och nordiska bolag har du även tillgång till årsredovisningar, fordonsrapporter & registreringsbevis på svenska bolag.

Denna utvecklarguide beskriver hur ett anrop kan se ut, vilka felkoder som kan dyka upp, generering av API-nycklar och förklarar vad som krävs för att integrera mot UC Direkt API.

UC Direkt API

Generellt för alla anrop

Samtliga anrop kräver att API-nyckeln skickas med i http-headern ‘x-apikey’. Alla rapporter levereras i json-format, och det rekommenderas att http-headern ’accept: application/json’ är satt. Årsredovisningar, fordonsrapporter och registreringsbevis levereras som PDF kodad i en Base64-sträng.

Produktionsmiljö adress UC Direkt service: direkt.uc.se

API host adress: direkt-api.uc.se/UCDirect-web/

Testmiljö adress

UC Direkt service: direkt-at.uc.se

API host adress: direkt.api-at.uc.se/UCDirect-web/

Exempel:

curl -X ‘GET’ https://host/company/businessreport?orgNo=0123456789’ \ -H ‘accept: application/json’ \

-H ‘x-apikey: abcde123456’

Exempel Företagsupplysning Svar:

}, "businessBasicInformation": { "organizationName": "UC AB", "organizationNo": "556137-5113",

"oldOganizationName": "Upplysningscentralen UC AB", "legalFormName": "Aktiebolag, privat",

"phone": "086709000",

"topExecutivePersonNo": "000000-0000", "topExecutiveName": "Förnamn Efternamn", "registrationDate": "1970-07-15",

"sni": "Inkassoföretags och kreditupplysningsföretags verksamhet",

(4)

Page

4

/

7

"sniCode": "82910",

"position": "VD och ord ledamot", "municipality": "Stockholm", "county": "Stockholms",

"municipalityAndCountyText": "Stockholm kommun i Stockholms län", "nameChangeDate": "2009-04"

}, "riskInformation": { "statusText": "Aktiv", "riskCode": "5",

"riskText": "5 - Mycket låg risk", "creditLimit": {

"amount": "10 000", "currency": "TSEK"

API endpoints

Som vi nämner ovan så finns fem olika rapporttyper vilka nås på varsin API-endpoint. Online- dokumentation nås via den här länken.

- Ett giltigt klientcertifikat krävs för att nå online-dokumentationen.

Anrop

Företagsrapport

Adress company/businessreport?orgNo={}

(5)

Metod GET

Format json

Nordisk företagsrapport

* countryCode = ‘FI’ ‘DK’ ‘NO’

Adress company/nordicreport?orgNo={}?countryCode

={}

Metod GET

Format json

Årsredovisning

Returnerar senast registrerade årsredovisning

Adress company/annualreport?orgNo={}

Metod GET

Format json

Fordonsrapport

Returnerar samtliga fordon som finns registrerade på bolaget

Adress company/vehiclereport?orgNo={}

Metod GET

Format json

Registreringsbevis

Adress company/registrationcertificate?orgNo={}

Metod GET

Format json

(6)

Page

6

/

7

Felmeddelanden

Om ett fel uppstår returneras ett json-svar med en http-statuskod enligt nedan:

HTTP-kod 400:

“Utgånget avtal – kontakta er referens på UC”

“Inga tics tillgängliga. För att beställa – kontakta er referens på UC”

”Inga fordonsrapporter tillgängliga. För att beställa – kontakta er referens på UC”

”Inga registreringsbevis tillgängliga. För att beställa – kontakta er referens på UC”

”Inga nordiska rapporter tillgängliga. För att beställa – kontakta er referens på UC”

“Felaktigt indata.”

“Felaktigt organisationsnummer.”

“Ingen årsredovisning tillgänglig för detta bolag.”

”Det finns ingen fordonsrapport att hämta för detta företag.”

”Ingen årsredovisning tillgänglig för detta bolag.”

“Ingen träff i UC:s register.”

HTTP-kod 401:

“Inaktiv API-nyckel/tillgång”

HTTP-kod 500:

“För närvarande har vi problem med underliggande system.”

“Okänt fel.”

“Tekniskt fel.”

Säkerhet

Tvåfaktorsautentisering

För att nyttja UC Direkt API krävs att en aktiv API-nyckel skickas med i http-headern ‘x-apikey’ i kombination med ett klientcertifikat för att bli auktoriserad.

Hantera API-nycklar

Det är mycket enkelt att hantera sina API-nycklar via UC Direkts webbgränssnitt. Inloggad med ert API-konto under fliken ‘Mitt konto’ kan API-nyckeln aktiveras, förnyas eller inaktiveras. För

närvarande kan endast en nyckel per konto/kund vara aktiv. Om en nyckel förnyas inaktiveras den tidigare nyckeln omedelbart.

- Tänk på att förvara era aktiva nycklar på ett säkert ställe. Om ni misstänker att en API-nyckel kan ha hamnat i orätta händer, bör ni omedelbart inaktivera eller förnya den.

- I nuläget går det endast att logga in med användarnamn & lösenord för att administrera API- nycklar

(7)

Klientcertifikat

Klientcertifikat beställs enligt en separat procedur då ni blir API-kund. UCs support kommer att kontakta er separat om detta. Tänk på att förvara certifikatets privata nyckel säkert. Finns det anledning att tro att den privata nyckeln kommit i orätta händer, kontakta UCs support omedelbart.

Testa er integration Testmiljö

Det finns en testmiljö uppsatt så att ni lättare ska komma igång med er integration mot UC Direkts API.

I denna miljö använder vi endast testobjekt som betyder att det inte är riktig data ni får i svar. Det betyder även att inga kopior skickas ut till omfrågade på de kopiepliktiga upplysningarna.

Det finns testobjekt för samtliga bolagsformer, medan registreringsbevis, årsredovisning &

fordonsrapport returnerar samma data oberoende vilket organisationsnummer som skickas med i frågan.

Kontaktinformation

E-post: integration@uc.se

(8)

Kontor Kontakt Firma

UC AB Telefon: 08-670 90 00 E-post: integration@uc.se Org.nr. 556137-5113 Årstaängsvägen 21 B Fax: 08-670 90 20 Webb: uc.se

117 88 Stockholm

(9)

Innehåll

... 1

Innehåll ... 2

Introduktion ... 3

UC Direkt API ... 3

Generellt för alla anrop ... 3

API endpoints ... 4

Anrop ... 5

Felmeddelanden ... 6

Säkerhet ... 6

Tvåfaktorsautentisering ... 6

Hantera API-nycklar ... 7

Klientcertifikat ... 7

Testa er integration ... 7

Testmiljö ... 7

Testobjekt ... 7

Kontaktinformation ... 7

(10)

Page

3

/

7

Introduktion

UC Direkt API levererar rapporter på ett enkelt och smidigt sätt.

Tjänsten är anpassad till företag med behov av snabba, enkla och tydliga besked. Förutom fullständiga kreditupplysningar på svenska och nordiska bolag har du även tillgång till årsredovisningar, fordonsrapporter & registreringsbevis på svenska bolag.

Denna utvecklarguide beskriver hur ett anrop kan se ut, vilka felkoder som kan dyka upp, generering av API-nycklar och förklarar vad som krävs för att integrera mot UC Direkt API.

UC Direkt API

Generellt för alla anrop

Samtliga anrop kräver att API-nyckeln skickas med i http-headern ‘x-apikey’. Alla rapporter levereras i json-format, och det rekommenderas att http-headern ’accept: application/json’ är satt. Årsredovisningar, fordonsrapporter och registreringsbevis levereras som PDF kodad i en Base64-sträng.

Produktionsmiljö adress UC Direkt service: direkt.uc.se

API host adress: direkt-api.uc.se/UCDirect-web/

Testmiljö adress

UC Direkt service: direkt-at.uc.se

API host adress: direkt.api-at.uc.se/UCDirect-web/

Exempel:

curl -X ‘GET’ https://host/company/businessreport?orgNo=0123456789’ \ -H ‘accept: application/json’ \

-H ‘x-apikey: abcde123456’

Exempel Företagsupplysning Svar:

}, "businessBasicInformation": { "organizationName": "UC AB", "organizationNo": "556137-5113",

"oldOganizationName": "Upplysningscentralen UC AB", "legalFormName": "Aktiebolag, privat",

"phone": "086709000",

"topExecutivePersonNo": "000000-0000", "topExecutiveName": "Förnamn Efternamn", "registrationDate": "1970-07-15",

"sni": "Inkassoföretags och kreditupplysningsföretags verksamhet",

(11)

"sniCode": "82910",

"position": "VD och ord ledamot", "municipality": "Stockholm", "county": "Stockholms",

"municipalityAndCountyText": "Stockholm kommun i Stockholms län", "nameChangeDate": "2009-04"

}, "riskInformation": { "statusText": "Aktiv", "riskCode": "5",

"riskText": "5 - Mycket låg risk", "creditLimit": {

"amount": "10 000", "currency": "TSEK"

API endpoints

Som vi nämner ovan så finns fem olika rapporttyper vilka nås på varsin API-endpoint. Online- dokumentation nås via den här länken.

- Ett giltigt klientcertifikat krävs för att nå online-dokumentationen.

Anrop

Företagsrapport

Adress company/businessreport?orgNo={}

(12)

Page

5

/

7

Metod GET

Format json

Nordisk företagsrapport

* countryCode = ‘FI’ ‘DK’ ‘NO’

Adress company/nordicreport?orgNo={}?countryCode

={}

Metod GET

Format json

Årsredovisning

Returnerar senast registrerade årsredovisning

Adress company/annualreport?orgNo={}

Metod GET

Format json

Fordonsrapport

Returnerar samtliga fordon som finns registrerade på bolaget

Adress company/vehiclereport?orgNo={}

Metod GET

Format json

Registreringsbevis

Adress company/registrationcertificate?orgNo={}

Metod GET

Format json

(13)

Felmeddelanden

Om ett fel uppstår returneras ett json-svar med en http-statuskod enligt nedan:

HTTP-kod 400:

“Utgånget avtal – kontakta er referens på UC”

“Inga tics tillgängliga. För att beställa – kontakta er referens på UC”

”Inga fordonsrapporter tillgängliga. För att beställa – kontakta er referens på UC”

”Inga registreringsbevis tillgängliga. För att beställa – kontakta er referens på UC”

”Inga nordiska rapporter tillgängliga. För att beställa – kontakta er referens på UC”

“Felaktigt indata.”

“Felaktigt organisationsnummer.”

“Ingen årsredovisning tillgänglig för detta bolag.”

”Det finns ingen fordonsrapport att hämta för detta företag.”

”Ingen årsredovisning tillgänglig för detta bolag.”

“Ingen träff i UC:s register.”

HTTP-kod 401:

“Inaktiv API-nyckel/tillgång”

HTTP-kod 500:

“För närvarande har vi problem med underliggande system.”

“Okänt fel.”

“Tekniskt fel.”

Säkerhet

Tvåfaktorsautentisering

För att nyttja UC Direkt API krävs att en aktiv API-nyckel skickas med i http-headern ‘x-apikey’ i kombination med ett klientcertifikat för att bli auktoriserad.

Hantera API-nycklar

Det är mycket enkelt att hantera sina API-nycklar via UC Direkts webbgränssnitt. Inloggad med ert API-konto under fliken ‘Mitt konto’ kan API-nyckeln aktiveras, förnyas eller inaktiveras. För

närvarande kan endast en nyckel per konto/kund vara aktiv. Om en nyckel förnyas inaktiveras den tidigare nyckeln omedelbart.

- Tänk på att förvara era aktiva nycklar på ett säkert ställe. Om ni misstänker att en API-nyckel kan ha hamnat i orätta händer, bör ni omedelbart inaktivera eller förnya den.

- I nuläget går det endast att logga in med användarnamn & lösenord för att administrera API- nycklar

(14)

Page

7

/

7

Klientcertifikat

Klientcertifikat beställs enligt en separat procedur då ni blir API-kund. UCs support kommer att kontakta er separat om detta. Tänk på att förvara certifikatets privata nyckel säkert. Finns det anledning att tro att den privata nyckeln kommit i orätta händer, kontakta UCs support omedelbart.

Testa er integration Testmiljö

Det finns en testmiljö uppsatt så att ni lättare ska komma igång med er integration mot UC Direkts API.

I denna miljö använder vi endast testobjekt som betyder att det inte är riktig data ni får i svar. Det betyder även att inga kopior skickas ut till omfrågade på de kopiepliktiga upplysningarna.

Det finns testobjekt för samtliga bolagsformer, medan registreringsbevis, årsredovisning &

fordonsrapport returnerar samma data oberoende vilket organisationsnummer som skickas med i frågan.

Kontaktinformation

E-post: integration@uc.se

(15)

References

Related documents

In simpler terms, the back-end system receives data from the front-end system, in our case the mobile application, and handles the data in different ways, for example a REST API,

<Statuskod text="Fusion pågår”>49</Statuskod> Företagets status enligt Bolagsverket **. <Ftgform lagerbolag="N”>Aktiebolag</Ftgform>

nihil aliud eH quam auri forma* In natura mbtli materia

EpisodeLength (integer): Délka epizody v minutách, Ended (boolean): Informace o tom zda je seriál ukončen, SmallImageFilePath (string): Cesta k malému obrázku,

Added in protocol 7 (API version 3.0) o TRANSFERRED – Refer to ALTER CALL TRANSFER command. o REDIAL_PENDING – This status is set when you press redial button on the Call Phones

Some ASIO drivers give the same value for minimum, prefered and maximum buffer size and only an external tool can be used to change the host buffer size when the driver is not

När du anropar ett API så måste en Access Token användas och helst ska den genereras dynamiskt från din applikation, gemensamt är att OAuth2 specifikationen används för detta}.

För att sedan komma fram till relevant teori som kan användas i arbetet - för att öka kunskapen samt förståelsen om hur man hanterar API:er i allmänhet.. Den induktiva