Getting Started

Autentisering

För att autentisera er mot tjänsten behövs en nyckel som anges i elementet open_session key. Denna nyckel fås av Allabolag i samband med tecknande av tjänst.

Exempel

Exempel på anrop med inloggning där YOUR-KEY byts ut mot den nyckel som du får av UC vid tecknande av tjänst:

<?xmlversion="1.0"encoding="utf-8"?>
<biwsXML_request type="find">
  <open_session key="YOUR-KEY" />
  <query>oms_X:&gt;50000 AND anst_X:&gt;500</query>
  <response>
    <sort field="jurnamn desc" />
    <records from="1" to="10">
    </records>
  </response>
</biwsXML_request>

Användning

Ett exempel på ett anrop visas nedan.

<biwsXML_request type="find|flow|fetch|group|UCmikro|UCrisk|UCstandard|arpdf|koncern|form">
  <open_session key="(string)" />
  <query>(query-string)</query>
  <wpquery>(query-string)</wpquery>
  <wpfilter>hq | all | none | wpid:nr | filterfield:filtertext</wpfilter>
  <year>(annual_report-year)</year>
  <response>
    <sort field="(fieldname [asc | desc])" />
    <groupby field="ba_postort" />
    <records from="(int)" to="(int)">
      <field name="(field1,field2,field3,...)" />
    </records>
  </response>
</biwsXML_request>

Det finns möjlighet att anropa flera olika tjänster genom BIWS, dessa anges i attributet type och ställer olika krav på inparametrar för att kunna exekvera förfrågan. 

Typer som kräver orgnr i query

 Type Beskrivning
 abregbevis  Hämta UC allabolag ABs Registrerings-bevis för ett bolag, resultat som streamad PDF
 koncern  Hämta en koncernstruktur i XML-format
 koncernHtml  Hämta en koncernstruktur i HTML-format
 checkUpdate  Kolla om det finns uppdaterat data
 fetchUpdate  Hämta uppdaterat data
 handleMonitor  Lägg till/Ta bort bolag I bevakning
 findEvents  Leta efter bolagshändelser
 fetchEvents  Hämta senaste bolagshändelser
 bolagsordning  Hämta en aktuell Bolagsordning från Bolagsverket för ett orgnr
 regbevis  Hämta ett aktuellt Registreringsbevis från Bolagsverket för ett orgnr

För att specificera organisations nummer i query fältet anger man orgnr: som prefix enligt följande exempel.

Anrop:

<?xmlversion="1.0"encoding="utf-8"?>
<biwsXML_request type="fetch">
  <open_session key="API KEY" />
  <query>orgnr:5561375113</query>
</biwsXML_request>

Svar:

<biwsXML_response type="fetch">
  <clientdata>
    <message />
    <query>orgnr:5561375113</query>
    <wpquery />
    <wpfilter />
    <saldo>9691746,6</saldo>
  </clientdata>
  <records total="1">
    <record nr="1">
      <abv_hgrupp>Foretagstjanster</abv_hgrupp>
      <abv_kod>82910</abv_kod>
      <abv_ugrupp>Inkasso- &amp; Kreditupplysningsverksamhet</abv_ugrupp>
      <aktiekapital>1000000</aktiekapital>
      <aktier_ant>10000</aktier_ant>
      <alias />
      <anstgrp>200-499</anstgrp>
      <anstgrp_kod>8</anstgrp_kod>
      <anst_X>301</anst_X>
      <ar_senast_pdf>20140627#201312</ar_senast_pdf>
      <ba_coadress />
      <ba_gatuadress>aRSTAaNGSVaGEN 21 B</ba_gatuadress>
      <ba_kommun>Stockholm</ba_kommun>
      <ba_lan>Stockholms lan</ba_lan>
      <ba_postnr>11743</ba_postnr>
      <ba_postort>Stockholm</ba_postort>
      <bolform>ab</bolform>
      <bolord>
Bolaget har till foremal for sin verksamhet att bedriva kreditupplysningsverksamhet, att tillhandahalla tjanster och in formation for marknadsforing, att tillhandahalla annan affarsin formation samt att bedriva annan darmed forenlig verksamhet.
</bolord>
      <bors_bolag>0</bors_bolag>
      <bors_listaid />
      <bpfirma />
      <brapport />
      <bv_boltyp>ab</bv_boltyp>
      <bv_regdatum>19700715</bv_regdatum>
      <cfar_antal>2</cfar_antal>
      <clicks>1</clicks>
      <datum14>20180307195424</datum14>
      <dottrar>
        <dotter>
          <namn>UC allabolag AB</namn>
          <orgnr>5567307367</orgnr>
        </dotter>
        <dotter>
          <namn>UC Affarsfakta AB</namn>
          <orgnr>5566130042</orgnr>
        </dotter>
      </dottrar>
      <firmatecknare>
Firman tecknas av styrelsen, Firman tecknas tva i forening av, -Beckman, Per Ingemar, -Bjorknert, Carl Mikael, -Borgcrantz, Karl Anders Allan, -Engstrom, Mats Goran, -Hugosson, Bengt Anders, -Nyblaeus, Nils-Fredrik, eller en av dem i forening med en av, -Dahlqvist, Sven ake, -David, Anna Helena, -Lagergren Bjursten, Oskar, -Lejon Rosvall, Linda Margareta, -ohlander, Anna Sophie Eleonor, Dessutom har verkstallande direktoren ratt att teckna firman, betraffande lopande forvaltningsatgarder
</firmatecknare>
      <ftgnamn>UC AB</ftgnamn>
      <ftgtyp>ab</ftgtyp>
    </record>
  </records>
</biwsXML_response>

Följande kräver även att år specificeras

 Type  Beskrivning 
 arpdf   Hämta en årsredovisning som base64-kodad PDF i XMLen 
 arpdfstream   Hämta en årsredovisning, resultat som streamad PDF 

Typer som kräver query-syntax 

 Type Beskrivning
 Find  Söka i bolagsdatabasen korrekt
 Flow  Sök företag, best match korrekt
 Fetch  Söka och hämta data korrekt

För att söka information används en fråga av typen FIND.

Ex på sökfråga för att hitta bolag som omsätter mer än 50 miljoner och har fler än 500 anställda.

Fråga:

<?xmlversion="1.0"encoding="utf-8"?>
<biwsXML_request type="find">
  <open_session key="API Nyckel" />
  <query>oms_X:&gt;50000 AND anst_X:&gt;500</query>
  <response>
    <sort field="jurnamn desc" />
    <records from="1" to="10">
    </records>
  </response>
</biwsXML_request>

 Svar:

<biwsXML_response type="find">
  <clientdata>
    <message />
    <query>oms_X:&gt;50000 AND anst_X:&gt;500</query>
    <wpquery />
    <wpfilter />
    <saldo>9691746</saldo>
  </clientdata>
  <records total="1373">
    <record nr="1">
      <nummer>5566650080</nummer>
      <orgnr>5566650080</orgnr>
      <jurnamn>900 meter i Sverige AB</jurnamn>
      <ba_postort>Stockholm</ba_postort>
      <abv_ugrupp>Personaluthyrning</abv_ugrupp>
      <abv_hgrupp>Bemanning &amp; Arbetsformedling</abv_hgrupp>
      <abv_kod>78200</abv_kod>
      <aktiekapital>100000</aktiekapital>
      <aktier_ant>1000</aktier_ant>
      <anstgrp>0</anstgrp>
      <anstgrp_kod>13</anstgrp_kod>
      <anst_X>3259</anst_X>
      <ar_senast_pdf>20150424#201412</ar_senast_pdf>
      <ba_gatuadress />
      <ba_kommun />
      <ba_lan />
      <ba_postnr>0</ba_postnr>
      <bolform>ab</bolform>
      <bolord>
Bolaget skall bedriva konsultverksamhet inom foretagsutveckling, forsaljning och kundvard samt forvalta vardepapper, avensom idka darmed forenlig verksamhet.
</bolord>
      <brapport />
      <bv_boltyp>ab</bv_boltyp>
      <bv_regdatum>20040816</bv_regdatum>
      <cfar_antal>1</cfar_antal>
      <oms_X>1878151</oms_X>
      <statdatakod>31</statdatakod>
    </record>
  </records>
</biwsXML_response>

Övriga typer

 Type Beskrivning Parameterkrav
 group  Gruppering av resultatet i sökfrågan  groupby måste anges
 checkMonitor  Kolla om nya händelser finns i bevakning  Biws-key
 account  Visa kontoinställningar, XML  Endast type