Rajapinnan käytön aloitus

Tämä opas auttaa sinut alkuun PalkkaOnline-rajapinnan käytössä. Käymme läpi, miten aloitat API-asiakkuuden ja miten teet ensimmäisen API-pyynnön.

PalkkaOnline-rajapinta on tällä hetkellä kehitysvaiheessa! Toistaiseksi rajapintaa voivat hyödyntää ainoastaan yhteistyökumppanit. Mikäli sinulla on kysyttävää, otathan tarvittaessa yhteyttä PalkkaOnlineen Tuki » Rajapinta.

Ensimmäisen API-pyynnön tekeminen

  1. Pyydä API tunnukset Tuki » Rajapinta.
  2. Luo API kutsu ja lisää seuraavat otsakkeet: Api-Key, Api-Secret ja Api-Identifier.
  3. Lähetä pyyntö PalkkaOnline päätepisteeseen esimerkiksi: https://uusi.palkkaonline.fi/api/v1/users.
  4. Saat vastauksena JSON-muotoisen listan kaikista Kevytyrittäjistä (joihin sinulla on oikeus).

Alla näet esimerkin siitä, miten lähetät GET-pyynnön Kevytyrittäjä päätepisteeseen saadaksesi listan kaikista Kevytyrittäjistä.

GET
/api/v1/users
  $client = new Client();
  $headers = [
    'Api-Key' => '{api-key}',
    'Api-Secret' => '{api-secret}',
    'Api-Identifier' => '{api-identifier}'
  ];
  $request = new Request('GET', 'http://uusi.palkkaonline.fi/api/v1/users', $headers);
  $res = $client->sendAsync($request)->wait();
  echo $res->getBody();
Lue lisää tietoa Kevytyrittäjä resurssista

Mitä seuraavaksi?

Hienoa, olet nyt tehnyt ensimmäisen API-pyynnön. Tässä muutamia linkkejä, jotka voivat olla hyödyllisiä, kun jatkat PalkkaOnline-rajapinnan tutkimista: