Hlavní výhodou rozhraní API v systému MasterBase® je, že umožňují automatizovat činnosti, které se na webové platformě provádějí ručně.
Mimo jiné to umožňují:
Aktualizujte své databáze ve svém pracovním prostředí a na naší platformě současně.
Vytvářejte a odesílejte zprávy ze svých systémů, aniž byste se museli přihlašovat k naší platformě.
Přijměte od společnosti MasterBase® metriky zásilky
MasterBase® API
Učte se z našich rozhraní API
Chcete-li sestavit adresu URL služby, kterou chcete využívat, musíte použít následující strukturu:
Základní adresa URL seskupující webové služby:
https://api2023.masterbase.com
ke kterému musíte nejprve přidat segment označující službu, na kterou odkazuje, a poté nepovinné parametry, které definují daný dotaz. Prvnímu z nich předchází otazník (?), za ním následuje znak rovnítka (=) a hodnota parametru. Od druhého parametru, který potřebujete přidat, musíte místo otazníku použít znak ampersand (&).
Příklad:
https://api2023.masterbase.com/contacts/v2/ClientName/?Od=123&Top=100&Order=1
Struktura
Obálka
Každá odpověď je obsažena ve struktuře nazvané obálka (obálka, obal). To znamená, že každá odpověď má předem definovanou strukturu, se kterou může interagovat.
{
"Service": "Název služby",
"Version": "Verze služby",
"TransactionId": "Alfanumerický identifikátor transakce",
"Status": {
Code": "Kód odpovědi", "Code": "Kód odpovědi", "Value": "Hodnota odpovědi",
"Value": "Hodnota odpovědi", "Value": "Hodnota odpovědi", "Value": "Hodnota odpovědi".
},
"Data": {}
} 
Stav
Klíč stav slouží k získání informací o odezvě služby. Pokud vše proběhlo správně, bude odpověď v atributu Code uvádět hodnotu 200 nebo 201. Může se však stát, že se něco pokazí, a v takovém případě bude odpověď tohoto typu:
"Status": {
"Kód": "401",
"Value": "Unauthorized"
} 
Ověřování
Pro využívání webových služeb dostupných na těchto stránkách je nutné vzít v úvahu, že autentizace přístupu je základní a pro tento účel se používají pověření API - uživatel a heslo -, které získáte prostřednictvím svého účtu MasterBase®. Jejich použití závisí na jazyce zvoleném pro konzumaci služeb a je na odpovědnosti uživatele.
