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.
Přístup k průvodci spotřebou rozhraní API MasterBase®
Kontakty - Správa kontaktů
API, které umožňuje synchronizovat kontaktní údaje uložené ve vašich interních systémech s údaji z databází v MasterBase®.
MassiveMail - Správa pošty
API, které umožňuje vytvářet zprávy a hromadné rozesílání bez přihlášení k platformě MasterBase®.
UniqueMail - Správa jedinečných zásilek
API, které umožňují provádět jednorázové zásilky z interních systémů bez nutnosti přihlášení k platformě MasterBase®.
Archiv - URL úložiště jednotlivých kampaní
API pro nahrávání a stahování souborů do a z cloudu MasterBase® pro hromadné rozesílání.
Config - Zobrazení konfiguračních dat
API k získání informací z polí jednotlivých databází.
Přístup k rozhraním API MasterBase® pro automatizaci procesů
Automatizace procesů - WS RDS
API umožňující vzdálenou správu záznamů v kolekci dat RDS.
Automatizace - WS File Bunker
API, které umožňuje ukládání souborů ve webovém prostředí.