Kevytyrittäjät

Tällä sivulla käsitellään kevytyrittäjän luontia ja hakua.

Kevytyrittäjä malli

Kevytyrittäjä malli sisältää kaikki tiedot kevytyrittäjästäsi, kuten etu- ja sukunimi, osoitetiedot, sähköposti ja puhelinnumero.

Ominaisuudet

Name
first_name
Type
string
Description
Kevytyrittäjän etunimi.
Name
last_name
Type
string
Description
Kevytyrittäjän sukunimi.
Name
email
Type
string
Description
Kevytyrittäjän sähköpostiosoite.
Name
phone
Type
string
Description
Kevytyrittäjän puhelinnumero.
Name
password
Type
string
Description
Kevytyrittäjän salasana.

GET/api/v1/users

Listaa kevytyrittäjät

Tämä päätepiste mahdollistaa kaikkien kevytyrittäjien hakemisen. Oletuksena näytetään kymmenen kevytyrittäjää per sivu.

Valinnaiset ominaisuudet

Request

GET

/api/v1/users

<?php
$client = new Client();
$headers = [
  'Api-Key' => '{api-key}',
  'Api-Secret' => '{api-secret}',
  'Api-Identifier' => '{api-identifier}'
];
$request = new Request('GET', 'https://uusi.palkkaonline.fi/api/v1/users', $headers);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();

Response

{
"users": [
    {
        "id": 1,
        "email": "testi@palkkaonline.fi",
        "first_name": "Maija",
        "last_name": "Meikäläinen",
        "phone": "+358414952572",
        "street_address": "asdasdas 123",
        "post_number": "70150",
        "city": "Kuopio",
        "country": "Suomi",
        "occupation": "Postimies",
        "business_idea": "40",
        "bank_account_number": "FI1857700520522373",
        "bank_identification_code": "SBANFIHH",
    },
    {
        "id": 2,
        // ...
    },
    {
        "id": 3,
        // ...
    },
  ]
}

POST/api/v1/users

Luo kevytyrittäjä

Tämä päätepiste mahdollistaa uuden kevytyrittäjän luomisen.

Vaaditut ominaisuudet

Name
first_name
Type
string
Description
Kevytyrittäjän etunimi.
Name
last_name
Type
string
Description
Kevytyrittäjän sukunimi.
Name
email
Type
string
Description
Kevytyrittäjän sähköpostiosoite.
Name
phone
Type
string
Description
Kevytyrittäjän puhelinnumero.

Pyyntö

POST

/api/v1/users

  <?php
  $client = new Client();
  $headers = [
    'Api-Key' => '{api-key}',
    'Api-Secret' => '{api-secret}',
    'Api-Identifier' => '{api-identifier}'
  ];
  $body = '{
    "first_name": "Maija",
    "last_name": "Meikäläinen",
    "email": "maija.meikalainen@esimerkki.fi",
    "phone": "0441234567"
  }';
  $request = new Request('POST', 'http://127.0.0.1:8000/api/create-user', $headers, $body);
  $res = $client->sendAsync($request)->wait();
  echo $res->getBody();

Vastaus

{
    "status": "success",
    "message": "User created successfully",
    "user": 80
}

GET/api/v1/users/:id

Hae kevytyrittäjä

Tämä päätepiste mahdollistaa kevytyrittäjän hakemisen id:n perusteella.

Request

GET

/api/v1/users/:id

const axios = require('axios');

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: 'https://uusi.palkkaonline.fi/api/v1/users/1',
  headers: { 
    'Api-Key': '{api-key}', 
    'Api-Secret': '{api-secret}', 
    'Api-Identifier': '{api-identifier}'
  }
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

Response

{
    "status": "success",
    "message": "Käyttäjä haettu onnistuneesti",
    "user": {
        "id": 1,
        "first_name": "Maija",
        "last_name": "Meikäläinen",
        "email": "testi@palkkaonline.fi",
        "phone": "+35844345678",
        "street_address": "asdasdas 123",
        "post_number": "70150",
        "city": "Kuopio",
        "country": "Suomi",
        "occupation": "Postimies",
        "business_idea": null,
        "bank_account_number": null,
        "bank_identification_code": null,
        "missing_information": true
    }
}

POST/api/v1/users/:id/:customerId

Liitä Asiakas

Tämä päätepiste mahdollistaa asiakkaan liittämisen kevytyrittäjälle. Asiakkaan tulee olla olemassa järjestelmässä.

Vaaditut ominaisuudet

Name
id
Type
integer
Description
Kevytyrittäjän id.
Name
customerId
Type
integer
Description
Asiakkaan id.

Pyyntö

POST

/api/v1/users/:id/:customerId

  <?php
  $client = new Client();
  $headers = [
    'Api-Key' => '{api-key}',
    'Api-Secret' => '{api-secret}',
    'Api-Identifier' => '{api-identifier}'
  ];
  $request = new Request('POST', 'https://uusi.palkkaonline.fi/api/v1/users/:id/:customerId', $headers);
  $res = $client->sendAsync($request, $options)->wait();
  echo $res->getBody();

Vastaus

{
    "status": "success",
    "message": "Asiakas lisätty käyttäjälle onnistuneesti"
}

DELETE/api/v1/users/:id/:customerId

Erota Asiakas

Tämä päätepiste mahdollistaa asiakkaan liitoksen poistamisen kevytyrittäjälle. Asiakkaan tulee olla olemassa järjestelmässä. Pyyntö ei poista asiakasta järjestelmästä.

Vaaditut ominaisuudet

Name
id
Type
integer
Description
Kevytyrittäjän id.
Name
customerId
Type
integer
Description
Asiakkaan id.

Pyyntö

POST

/api/v1/users/:id/:customerId

  <?php
  $client = new Client();
  $headers = [
    'Api-Key' => '{api-key}',
    'Api-Secret' => '{api-secret}',
    'Api-Identifier' => '{api-identifier}'
  ];
  $request = new Request('DELETE', 'https://uusi.palkkaonline.fi/api/v1/users/:id/:customerId', $headers);
  $res = $client->sendAsync($request, $options)->wait();
  echo $res->getBody();

Vastaus

{
    "status": "success",
    "message": "Asiakas lisätty käyttäjälle onnistuneesti"
}