Yhteystietorajapinta

Yleistä

Yhteystietorajapinta on tarkoitettu soittajan tunnistamiseen puhelinnumeron perusteella. Rajapintaa ei ole mahdollista käyttää muuhun tarkoitukseen.

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

Yhteystietorajapinta

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

GET /v2/contacts/search - Hakee yhteystietoja puhelinnumeron perusteella

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 Yhteystietorajapinnan toimintaa rajatusti ja suoraan ilman tunnistautumista.

Käyttäminen

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

Yhteystieto-API

/v2/contacts/search

Esim. /v2/contacts/search?what=puhelinnumero

Tarkemmat tiedot rajapinnoista löytyvät kohdasta Tekninen dokumentaatio