MasterBase® APIde peamine eelis on see, et need võimaldavad automatiseerida tegevusi, mida veebiplatvormil tehakse käsitsi.
Muu hulgas teevad nad selle võimalikuks:
Uuendage oma andmebaase oma töökeskkonnas ja meie platvormil samaaegselt.
Looge ja saatke sõnumeid oma süsteemidest, ilma et peaksite meie platvormile sisse logima.
Saate MasterBase®-lt oma saadetise näitajad.
MasterBase® API
Õppige meie APIdest
Teenuse URL, mida soovite tarbida, tuleb konstrueerida järgmise struktuuriga:
Veebiteenuste rühmitamise baas-URL:
https://api2023.masterbase.com
millele tuleb kõigepealt lisada segment, mis näitab teenust, millele see osutab, ja seejärel valikulised parameetrid, mis määratlevad teie päringu. Neist esimesele eelneb küsimärk (?), millele järgneb võrdusmärk (=) ja parameetri väärtus. Teisest lisatavast parameetrist tuleb küsimärgi asemel kasutada küsimärgi asemel ampersandi märki (&).
Näide:
https://api2023.masterbase.com/contacts/v2/ClientName/?From=123&Top=100&Järjekord=1
Struktuur
Ümbrik
Iga vastus sisaldub struktuuris nimega ümbrik (ümbrik, pakend). See tähendab, et igal vastusel on etteantud struktuur, millega ta saab suhelda.
{
"Service": "Service name",
"Version": "Teenuse versioon",
"TransactionId": "Tehingu tähtnumbriline identifikaator",
"Status": {
Code": "Vastuse kood", "Code": "Vastuse kood", "Value": "Vastuse väärtus",
"Value": "Vastuse väärtus", "Value": "Vastuse väärtus", "Value": "Value of the response
},
"Data": {}
}
Staatus
Võti staatus kasutatakse teabe saamiseks teenuse vastuse kohta. Kui kõik on kulgenud korrektselt, näitab vastus atribuudis Code väärtust 200 või 201. Siiski võib juhtuda, et midagi läheb valesti, sellisel juhul on vastus seda tüüpi:
"Staatus": {
"Kood": "401",
"Value": "Unauthorized"
}
Autentimine
Sellel veebisaidil kättesaadavate veebiteenuste kasutamiseks on vaja arvestada, et juurdepääsutõend on põhiline ja selleks kasutatakse API volitusi - kasutaja ja salasõna -, mis saadakse teie MasterBase® konto kaudu. Nende kasutamine sõltub teenuste tarbimiseks valitud keelest ja on kasutaja vastutusel.