Asiakasrekisteriin voi tallentaa asiakkaita, jolloin maksulinkkejä tehdessä ei tarvitse syöttää uudestaan asiakkaan tietoja.
Endpoint | Toiminto |
---|---|
GET api/v1/customers | Listaa asiakkaat |
POST api/v1/customers | Lisää asiakas |
GET api/v1/customers/{customerId} | Hae asiakkaan tiedot |
PUT api/v1/customers/{customerId} | Muokkaa asiakasta |
DELETE api/v1/customers/{customerId} | Poista asiakas |
Listaa asiakkaat
Listaa kaikki asiakkaat. Asiakkaat ovat aakkosjärjestyksessä.
Parametrit
page
Vapaaehtoinen
Sivu miltä asiakkaat haetaan. Rajapinta palauttaa 50 asiakasta yhdellä sivulla.
GET api/v1/customers
cURL
curl -i -X GET -H "Authorization:Token API-AVAIN" 'https://test.app.paylink.fi/api/v1/customers?page=1'
Vastaus
{
"has_more": false,
"data": [
{
"id": 1,
"email": "matti.meikalainen@example.com",
"customer_locale": "fi_FI",
"address": {
"firstname": "Matti",
"lastname": "Meikäläinen",
"company": "",
"company_id": "",
"address": "Testikatu 1",
"city": "Helsinki",
"postcode": "00100",
"phone": "+358401234567",
"country": "FI"
},
"created_at": "2020-08-13T14:19:29.000+03:00",
"updated_at": "2020-08-13T14:40:01.000+03:00"
},
...
]
}
Lisää asiakas
Luo uusi asiakas
Parametrit
email
Pakollinen
Asiakkaan sähköpostiosoite
customer_locale
Vapaaehtoinen
Asiakkaan kieli,
fi_FI
tai en_US
. Oletus fi_FI
address
Pakollinen
Asiakkaan yhteystiedot. Mikäli jotain pakollista kenttää ei ole tiedossa, voi sen tilalla käyttää väliviivaa (
-
).Lapsiparametrit
address.firstname
Pakollinen
Asiakkaan etunimi
address.lastname
Pakollinen
Asiakkaan sukunimi
address.company
Vapaaehtoinen
Asiakkaan yrityksen nimi
address.company_id
Vapaaehtoinen
Asiakkaan yrityksen y-tunnus
address.city
Pakollinen
Asiakkaan postitoimipaikka
address.postcode
Pakollinen
Asiakkaan postinumero
address.phone
Vapaaehtoinen
Asiakkaan puhelinnumero
address.country
Pakollinen
Asiakkaan maa kaksikirjaimisena maakoodina (esim.
FI
)POST api/v1/customers
cURL
curl -i -X POST \
-H "Authorization:Token API-AVAIN" \
-H "Content-Type:application/json" \
-d \
'{
"email": "matti.meikalainen@example.com",
"customer_locale": "fi_FI",
"address": {
"firstname": "Matti",
"lastname": "Meikäläinen",
"address": "Testikatu 1",
"postcode": "00100",
"city": "Helsinki",
"phone": "0401234567",
"country": "FI"
}
}' \
'https://test.app.paylink.fi/api/v1/customers'
Vastaus
{
"id": 1,
"email": "matti.meikalainen@example.com",
"customer_locale": "fi_FI",
"address": {
"firstname": "Matti",
"lastname": "Meikäläinen",
"company": null,
"company_id": null,
"address": "Testikatu 1",
"city": "Helsinki",
"postcode": "00100",
"phone": "0401234567",
"country": "FI"
},
"created_at": "2020-08-18T13:12:06.000+03:00",
"updated_at": "2020-08-18T13:12:06.000+03:00"
}
Hae asiakkaan tiedot
Hakee yhden asiakkaan tiedot asiakas-ID:n perusteella.
Parametrit
customerId
Pakollinen
Asiakkaan ID
GET api/v1/customers/{customerId}
cURL
curl -i -X GET \
-H "Authorization:Token API-AVAIN" \
'https://test.app.paylink.fi/api/v1/customers/1'
Vastaus
{
"id": 1,
"email": "matti.meikalainen@example.com",
"customer_locale": "fi_FI",
"address": {
"firstname": "Matti",
"lastname": "Meikäläinen",
"company": null,
"company_id": null,
"address": "Testikatu 1",
"city": "Helsinki",
"postcode": "00100",
"phone": "0401234567",
"country": "FI"
},
"created_at": "2020-08-18T13:12:06.000+03:00",
"updated_at": "2020-08-18T13:12:06.000+03:00"
}
Muokkaa asiakasta
Muokkaa asiakkaan tietoja
Parametrit
customerId
Pakollinen
Asiakkaan ID
Kts. muut parametrit kohdasta Lisää asiakas »
PUT api/v1/customers/{customerId}
cURL
curl -i -X PUT \
-H "Authorization:Token API-AVAIN" \
-H "Content-Type:application/json" \
-d \
'{
"email": "matti.meikalainen@example2.com",
"address": {
"firstname": "Uusi nimi"
}
}' \
'https://test.app.paylink.fi/api/v1/customers/1'
Vastaus
{
"id": 1,
"email": "matti.meikalainen@example2.com",
"customer_locale": "fi_FI",
"address": {
"firstname": "Uusi nimi",
"lastname": "Meikäläinen",
"company": null,
"company_id": null,
"address": "Testikatu 1",
"city": "Helsinki",
"postcode": "00100",
"phone": "0401234567",
"country": "FI"
},
"created_at": "2020-08-18T13:12:06.000+03:00",
"updated_at": "2020-08-18T13:19:21.000+03:00"
}
Poista asiakas
Poistaa asiakkaan.
Parametrit
customerId
Pakollinen
Asiakkaan ID
DELETE api/v1/customers/{customerId}
cURL
curl -i -X DELETE \
-H "Authorization:Token API-AVAIN" \
'https://test.app.paylink.fi/api/v1/customers/24'