Paylinkin rajapinnan avulla Paylinkin voi yhdistää muihin järjestelmiin. Rajapinta on REST-rajapinta, joka hyödyntää JSONia.
Rajapinnan avulla voi esimerkiksi:
- Luoda ja lähettää maksulinkin ulkoisesta järjestelmästä
- Viedä tilausten tiedot ulkoiseen järjestelmään
- Tuoda Paylinkiin asiakas- ja tuotetietoja
Osoitteet
Paylinkillä on kaksi ympäristöä:
- Tuotanto: https://app.paylink.fi/api/v1
- Testi: https://test.app.paylink.fi/api/v1
Vain suojattu (HTTPS) yhteys on sallittu.
API-tunnukset
Paylinkissä jokaisella käyttäjällä on yksilöllinen API-avain, mitä käytetään rajapintakutsuissa. Avaimen voi hakea ja tarvittaessa uudistaa kohdasta Paylink > Asetukset > API.
Integraatioiden testaamiseen ja kehittämiseen on käytettävä testiympäristöä. Tilaa testitunnukset tästä »
Tunnistautuminen
Rajapintaan tunnistaudutaan lisäämällä HTTP headeriin API-avain.
| Nimi | Arvo |
| Authorization | Token <API-AVAIN> |
cURL-esimerkki:
curl -i -X GET -H "Authorization:Token ce6988f6-6fb24b1f843ca1717a0f93f72b1cc78c" 'https://test.app.paylink.fi/api/v1/orders.json'Virheet
Rajapinta palauttaa HTTP-koodin, josta selviää, onko pyyntö onnistunut.
| 2xx | Pyyntö onnistui |
| 4xx | Pyyntö epäonnistui |
| 5xx | Järjestelmävirhe, esimerkiksi virheellinen JSON |
Lisäksi useissa virheissä järjestelmä palauttaa tarkemman virheilmoituksen vastauksen sisällössä (body). Esimerkiksi jos sähköposti puuttuu tilauksen tiedoista:
{
"errors": [
"Sähköposti pakollinen tieto",
"Sähköposti on virheellinen"
]
}
