Käytön aloittaminen - Lemonsoft

Tarvitset rajapinnan käyttämiseen API-avaimen ja asianmukaiset käyttöoikeudet. Lisätietoja tästä on käyttäjähallinnan ohjeessa.

Rajapinnan testaaminen

Rajapinnan osoite

Rajapinnan osoite löytyy käyttäjähallinnasta ympäristön hallinnasta ja välilehdeltä palveluiden osoitteet. REST-rajapinnan osoite on kentässä Rest API. Osoite on rajapinnan default-sivu.

Voit testata oikeellisuuden yksinkertaisesti menemällä selaimella ko. osoitteeseen. Jos osoite on väärä tai palvelu ei ole käytössä, selain antaa virheen HTTP 404.

Mikäli osoite on oikein ja palvelu toimii, selain ei anna virhettä, vaan esittää otsikon Lemonsoft integration REST API.

Toimivuuden varmistaminen

Testaa rajapinnan toimivuus selaimessa swaggerin avulla. Oikean URL-osoitteen saat ottamalla rajapinnan osoitteen ja lisäämällä perään /swagger/ui/index#

Esimerkki:

Rajapinnan osoite on: https://rest-s01-prod02.lemonsoft.eu/Lemonsoft30

Swagger osoite on: https://rest-s01-prod02.lemonsoft.eu/Lemonsoft30/swagger/ui/index#

Näet Swaggerissa ensimmäisenä autentikaatiometodin, jonka avulla voit testata että palvelu vastaa.

Näet get kohdasta kutsun /api/auth/alive. Testaa koko kutsu selaimella lisäämällä get-kutsu rajapinnan osoitteen perään. Esimerkissämme kutsu on: rest-s01-prod02.lemonsoft.eu/Lemonsoft30/api/auth/alive

Selain vastaa onnistuneesta kutsusta:

{
    "ok": false,
    "has_errors": false,
    "errors": []
}

Ja epäonnistunut kutsu antaa Server error virheen 404.