Api
Api
Rajapinnan osoite:
https://app.adensy.com/LoihdinApp/json-v1/episteme2/production/ + operaatio + parameterit
Tunnistautuminen
Rajapintakutsujen yhteydessä välitetään tunnistautumistiedot välittämällä parametrit apicode ja password. Tunnukset voidaan avata ottamalla yhteyttä tukeemme tuki@adensy.com.
Virheellinen tunnistautuminen palauttaa 403 – virheilmoituksen.
Tietolähteet
Rajapinnan kautta pääsee käsiksi lähes kaikkeen palveluun kirjattuun tietoon, jotka on eritelty jatkossa tietolähteinä. Alla on listattu useimmiten käytetyt tietolähteet.
Myynti ja asiakkuudet
Source (selite)
company (Yritysrekisteri)
contactperson (Kontaktirekisteri)
salesdocument (Dokumentit)
activity (Aktiviteetit)
lead (Liidit)
opportunity (Myyntimahdollisuudet)
quote (Tarjoukset)
quoteline (Tarjousrivit)
Tilaukset ja laskutus
Source (selite)
contract (Tilaukset)
contractlineitem (Tilausrivit)
invoice (Laskut)
invoicelineitem (Laskurivit)
Työnohjaus ja ajojärjestely
Source (selite)
person (Työntekijät / autot)
task (Asiakastyöt / Ajot)
workrecord (Tuntikirjaukset)
taskmaterialline (materiaalit / tavarat)
Operaatiot
Nimi ja kuvaus
add Rivin lisäys tietokantaan
update Rivin päivitys
delete Rivin poistaminen
list Rivien listaus
deletedlist Poistettujen rivien listaus
get Yksittäisen rivin haku
search Haku
dictionary/fields Kenttien kuvaus
Add
Tässä esimerkissä lisätään henkilö kontaktirekisteriin.
​
https://app.adensy.com/LoihdinApp/json-v1/episteme2/production/add?apicode= adensydemo&password=api2018&source=contactperson&data={
"firstname": "Erkki2",
"lastname": "Esimerkki",
"company": "192228",
"jobtitle": "Sihteeri",
"phonenumber": "09B3583493493",
"mobilephone": "09B3583493493",
"email": "Erkki@uusioy.fi"
}
​
Parametrit:
Source: Tietolähde, johon rivi lisätään
data: JSON – muotoiltu tietosisältö, jossa uuden rivin tiedot.
Vastausviesti:
Sisältää seuraavat tiedot:
Success: tieto siitä, onko operaatio onnistunut
Rowid: uuden rivin tunniste
{"rowid":344160,"success":true}
Update:
"firstname": "Erkki",
"lastname": "Esimerkki",
"jobtitle": "Toiminnanjohtaja",
"phonenumber": "\u002B358405512345",
"mobilephone": "\u002B358405512345",
"email": "erkki@sininauha.fi"
}
Parametrit:
Source: Tietolähde, johon päivitys kohdistuu
data: JSON – muotoiltu tietosisältö, jossa uuden rivin tiedot.
rowid: Rivin tunniste
Vastausviesti:
Sisältää seuraavat tiedot:
Success: tieto siitä, onko operaatio onnistunut
Rowid: päivitetyn rivin id (pysyy samana)
response {"rowid":290314,"success":true}
Delete
https://app.adensy.com/LoihdinApp/json-v1/episteme2/production/delete?apicode=jsonapi2018& password=1&rowid=343620&source=contactperson
Parametrit:
Source: Tietolähde, johon päivitys kohdistuu
rowid: Rivin tunniste
Vastausviesti:
Sisältää seuraavat tiedot:
Success: tieto siitä, onko operaatio onnistunut
Rowid: poistetun rivin id (pysyy samana).
{"rowid":343620,"success":true}
List
Tässä esimerkissä haetaan tietoja kontaktirekisteristä.
Parametrit:
Source: Tietolähde, josta tietoja haetaan
Order: Paluuaineiston jäjestys
Limit: Maksimi palautettavien rivien määrä
Returnfields: Palautettavat kentät. Käytä All, jos haluat palauttaa kaikki kentät.
LastSynced: Aikaleima. Palautetaan ne rivit, joita on muokattu tai lisätty tämän jälkeen.
HUOM:
Maksimimäärä palautettavia rivejä on tällä hetkellä 1000. Suosittelemme käyttämään tätä operaatiota silloin kun tietoja synkronoidaan kahden ohjelma välillä. Muussa tapauksessa on suositeltavaa käyttää search-operaatiota.
Vastausviesti
Jokainen vastausviesti sisältää seuraavat kentät
Title: Rivin otsikko
Versionnr: Rivin versionumero, joka kasvaa kun riviä päivitetään
Createdby: Rivin lisääjän käyttäjän ID
CreatedDate: Rivin lisäys pvm
Allowed-Operations: Kun käytetään käyttäjäkohtaista tunnistautumista, palauttaa tiedot siitä mihin toimintoihin tällä tunnuksella on oikeus.
EditedBy: Viimeisimmän muokkauksen tehneen käyttäjän tunnus. Jos muokkaus tulee Extranetin kautta tunnus viittaa asiakkaan henkilöön, jolle on perustettu käyttäjätunnus.
EditedDate: Viimeisimmän muokkauksen pvm
ReturnFields: Rivin tiedot. Tietosisältö riippuu valitusta tietolähteestä.
[
{
"title":"Mikko Salla",
"versionnr":28,
"createdby":-1,
"createddate":2009-12 -09,
"allowed-operations":"list,view,add,remove,edit,viewhistory",
"editedby":45,
"editeddate":2018-10 -09,
"rowid":58,
"fields":{
"banphonemarketing":false,
"segments":[
],
"lastname":"Salla",
"extranetaccesstoorders":false,
"isextranetuser":false,
"needmanualupdate":false,
"mobilephone":"",
"jobtitle":"As3232",
"contactclass":{
"title":"",
"rowid":""
},
"defaultforcompany":{
"title":"",
"rowid":""
},
"fullcontactsearchsuccess":false,
"extranetaccesstoquotes":false,
"unansweredcallcount":0,
"customernr":"3",
"companylinks":[
],
"mailchimpemail":"mikko.salla@jarr.fi",
"phonenumber":"",
"fax":"",
"banemailmarketing":false,
"allowmarketing":false,
"fullcontactsearchdone":false,
"extranetaccesstocontactpersons":false,
"callliststatus":{
"text":"Kontaktoimaton",
"listid":"0"
},
"firstname":"Mikko",
"privatecustomer":false,
"extranetaccesstoaddress":false,
"isextranetadmin":false,
"extranetaccesstoinvoices":false,
"privatecustomerstatus":{
"text":"Ei asiakashistoriaa",
"listid":"0"
},
"answeredcallcounttotal":0,
"email":"mikko.salla@jarr.fi",
"bansmsmarketing":false,
"company":{
"title":"Jarr Oy",
"rowid":46
},
"owner":{
"title":"Tero Nieminen",
"rowid":321
},
"unansweredcallcounttotal":0
}
}
]
Vinkki toteutukseen:
1. Tämä operaatio voi palauttaa samoja rivejä kuin aikaisempi kutsu. Rajapinnan toteuttajana sinun tulee huomioida tämä mikäli tallennat tietoa toiseen järjestestelmään.
​
2. Kun käytät List-operaatiota ota, seuraavat suosittelemme että otat talteen viimeisimmän palautetun rivin editeddate - ajankohdan. Käytä sitä parameterina kun seuraavan kerran käytät tätä operaatiota samasta tietolähteestä.
​
3. Tämä metodi palauttaa vain tietyn ajankohdan jälkeen muokatut ja lisätyt rivit. Rajapinnan käyttäjän tulee käyttää ListDeleted-operaatiota tunnistamaan poistetut rivit.
​
ListDeleted
https://app.adensy.com/LoihdinApp/ json-v1/episteme2/production/deletedlist?apicode=jsonapi2018&password=1&lastsynced=2018-10-10 00:00:00
Parametrit:
LastSynced: Aikaleima. Palautetaan ne rivit, jotka on poistettu aikaleiman jälkeen.
Vastausviesti:
Jokainen vastausviesti sisältää seuraavat kentät:
Dataclass: Tietolähde, johon poisto on kohdistettu
Rowid: Poistetun rivin tunniste.
[{"dataclass":"contactperson","rowid":296568}]
Get
Parametrit:
Rowid: Rivin tunniste.
dataclass: Tietolähde, josta tiedot haetaan.
Vastausviesti:
Paluu viesti kuten list – operaatiossa.
Search
Parametrit:
Source Tietolähde, josta tiedot haetaan.
Query: hakuehto, esim:
firstname:mikko (kaikki, joiden etunimi on mikko)
firstname*mik (kaikki, joiden etunimessä on teksti mik)
Muut operaattorit:
> suurempi kuin
< pienempi kuin
usean operaattorin käyttö:
Vastausviesti:
Listaus ROWID-tunnisteista.
Dictionary/Fields
Parametrit:
Source Tietolähde, jonka kentät listataan
Paluuviesti (Lyhennetty):
Huom: Asiakaskohtaiset lisäkentät näkyvät paluu viestissä _ext – alkuisina.
{
"id":"contactperson",
"description":"kontakti",
"fields":[
{
"id":"contactclass",
"desription":"kontaktiluokka",
"type":"object"
}, {
"id":"firstname",
"desription":"etunimi",
"type":"text"
},
{
"id":"lastname",
"desription":"sukunimi",
"type":"text"
},
{
"id":"company",
"desription":"yritys",
"type":"object"
},
{
"id":"mobilephone",
"desription":"matkapuhelin",
"type":"text"
},