File-Api tarjoaa pääsyn palveluun ladattaviin dokumentteihin.

HUOM!

Tämä rajapinta vaatii toimiakseen Data-Apin kautta pääsyn dokumentteihin, josta noudetaan dokumentin ID

Tiedosto haetaan muodostamalla seuraavan muotoinen kutsu:

https:///app.helppocrm.fi/LoihdinApp/file-api/v1/publicfile/APICODE/FILEID/FILENAME

APICODE  = rajapinnan Apikoodi, jonka saatte kun perustatte rajapintayhteyden

FILEID = dokumentin tunnus, jonka saatte kun haette dokumentteja Data-apin avulla

FILENAME = dokumentin nimi, jonka saatte kun haette dokumentteja Data-apin avulla

Voitte hakea dokumentteja Data-Apin kutsujen avulla.

Alla esimerkki Search - kutsusta, jossa täytyy pyytää rajapintaa palauttamaan dokumentin tiedot.

ttps://app.helppocrm.fi/LoihdinApp/data-api/v1/search?apicode=X&password=X&source=company&query=name*a&returnfields=name,logo&pagestart=0&pagesize=10

Tämä kutsu palauttaa niiden yrityksien logot, joissa on a-kirjain.

Ote vastausviestistä:

[{"logo":{"filename":"logo.jpg","fileid":"3fdfe-3443-d34d-343e-dfd34534-34f344"}