Główną zaletą interfejsów API w MasterBase® jest to, że umożliwiają one automatyzację działań wykonywanych ręcznie na platformie internetowej.
Między innymi dzięki nim jest to możliwe:
Aktualizuj bazy danych w swoim środowisku pracy i na naszej platformie jednocześnie.
Twórz i wysyłaj wiadomości ze swoich systemów bez konieczności logowania się na naszą platformę.
Otrzymywanie od MasterBase® danych dotyczących przesyłek
MasterBase® API
Dowiedz się więcej z naszych interfejsów API
Co to są interfejsy API MasterBase® i do czego służą?
Aby skonstruować adres URL usługi, którą chcesz wykorzystać, musisz to zrobić z następującą strukturą:
Podstawowy adres URL grupujący usługi sieci Web:
https://api2023.masterbase.com
do którego należy najpierw dodać segment wskazujący usługę, na którą wskazuje, a następnie opcjonalne parametry, które definiują dane zapytanie. Pierwszy z nich poprzedzony jest znakiem zapytania (?), po którym następuje znak równości (=) i wartość parametru. Od drugiego parametru, który należy dodać, należy użyć znaku ampersand (&) zamiast znaku zapytania.
Przykład:
https://api2023.masterbase.com/contacts/v2/ClientName/?Od=123&Top=100&Order=1
Struktura
Koperta
Każda odpowiedź jest zawarta w strukturze zwanej koperta (koperta, opakowanie). Oznacza to, że każda odpowiedź ma predefiniowaną strukturę, z którą może współdziałać.
{
"Service": "Nazwa usługi",
"Version": "Wersja usługi",
"TransactionId": "Alfanumeryczny identyfikator transakcji",
"Status": {
Code": "Kod odpowiedzi", "Code": "Kod odpowiedzi", "Value": "Wartość odpowiedzi",
"Value": "Wartość odpowiedzi", "Value": "Wartość odpowiedzi".
},
"Data": {}
}
Status
Klucz status służy do uzyskania informacji o odpowiedzi usługi. Jeśli wszystko przebiegło poprawnie, odpowiedź wskaże w atrybucie Code wartość 200 lub 201. Może się jednak zdarzyć, że coś pójdzie nie tak, w takim przypadku otrzymana odpowiedź będzie tego typu:
"Status": {
"Kod": "401",
"Wartość": "Nieautoryzowany"
}
Uwierzytelnianie
W celu korzystania z usług internetowych dostępnych na tej stronie należy wziąć pod uwagę, że uwierzytelnianie dostępu jest podstawowe i w tym celu wykorzystywane są dane uwierzytelniające API - użytkownik i hasło - które są uzyskiwane za pośrednictwem konta MasterBase®. Korzystanie z nich zależy od języka wybranego do korzystania z usług i jest obowiązkiem użytkownika.