Palveluhaku-API

Yleistä

Palveluhaku-API mahdollistaa yritysten toimipisteiden sekä niiden yhteystietojen hakemisen tietyiltä toimialoilta.

Tunnistautuminen

Kutsu: POST https://auth.fonapi.fi/token/login Headerit: Content-Type: application/x-www-form-urlencoded Body: grant_type=client_credentials&client_id= oma_client_id&client_secret=oma_client_secret

Vastaus:

    {
      "access_token":"8e2da0f9-b32c-1bc8-eedd-7c259c37d51b",
      "token_type":"Bearer",
      "expires_in":"90000",
      "scope":[{"service":"SEARCH_contacts_watch",
      "permission":"READ","orderId":null}],
      "uniqueId":null,
      "clientId":"oma_client_id"
    }

Tämän jälkeen kaikissa kutsuissa Yhteystieto-APIn pitää kuljettaa access_token kentässä olevaa arvoa header-tietona:

Authorization: Bearer 8e2da0f9-b32c-1bc8-eedd-7c259c37d51b

Palveluhaku-API

Rest API -osoite: https://search.fonapi.fi/

GET /v2/contacts/boundingBoxSearch - Hakee yrityksiä, yhteisöjä sekä yksityishenkilöitä, mutta rajatummin koordinaatein

GET /v2/contacts/lineOfBusinesses - Voit hakea toimialakoodilla yrityksiä ja rajata koordinaatein

Virheviestit

HTTP Status koodit

200 Kaikki OK.

401 Ei oikeutta palveluun. Avain voi olla vanhentunut.

500 Sisäinen virhe. Ole yhteydessä tukeen.

Tekninen API-dokumentaatio

 

Konsoli

Tarkoitus

Konsolin avulla voi testata Yhteystieto- ja Palveluhaku-APIen toimintaa rajatusti ja suoraan ilman tunnistautumista.

Käyttäminen

Konsolin käyttäminen on rajoitettu Yhteystieto- ja Palveluhaku-rajapintoihin ja Fonecta-aiheisiin tuloksiin. Konsoli on käytettävissä tableteilla ja niitä suuremmilla laitteilla.

Yhteystieto-API

/v2/contacts/search

Esim. /v2/contacts/search?what=fonecta&where=televisiokatu

/v2/contacts/businessId/{businessId}

Vain business id 17550076 on haettavissa:

/v2/contacts/businessId/17550076

/v2/contacts/autocomplete

esim. /v2/contacts/autocomplete?what=media

Palveluhaku-API

/v2/contacts/boundingBoxSearch

Esim. /v2/contacts/boundingBoxSearch?what=fonecta&pinLatitude=60.20413&pinLongitude=24.92520&topLeftLatitude=60.20459&topLeftLongitude=24.92383& bottomRightLatitude=60.20416&bottomRightLongitude=24.92533

Koordinaattirajauksella ei konsolissa ole vaikutusta

/v2/contacts/lineOfBusinesses

Vain lineOfBusiness A3300C on haettavissa:

/v2/contacts/lineOfBusinesses?lineOfBusinessCode=A3300C

Tarkemmat tiedot rajapinnoista löytyvät kohdasta Tekninen dokumentaatio