Temat: API – podstawy łączenia się + proste zapytania
API (Application Programming Interface) : interfejs programowania aplikacji udostępniany przez wiele serwisów sieciowych. API udostępnia zbiór procedur, protokołów oraz narzędzi umożliwiających wysyłanie i odbieranie zawartości danego serwisu. Za pomocą odpowiedniego języka programowania API pozwala na wysyłanie żądań dosatępu do usług z jednej aplikacji do drugiej. 3 kluczowe rodzaje API to: REST API, SOAP API oraz RPC API.
REST API: (Representational State Transfer API) to przede wszystkim część usług sieciowych przeznaczona do wykonywania żądań i otrzymywania feedbacku przy zastosowaniu funkcji HTTP. Istnieją 4 główne polecenia HTTP, na których bazuje REST API, a mianowicie – GET, PUT, POST, DELETE.
SOAP API: (Simple Object Access Protocol), czyli protokół trzymający się określonych standardów. Jest zależny od poszczególnych systemów i programowania opartych na XML. Warto również wspomnieć, iż wymaga on większej ilości informacji do prawidłowego funkcjonowania niż inne rodzaje tej technologii. SOAP API wykorzystuje się najczęściej w interfejsach programowania aplikacji dedykowanych instytucjom finansowym.
RPC API: (Remote Procedure Call) w dużym skrócie odpowiada za zdalne wywoływanie procedury. Była to najwcześniejsza forma API zaprojektowana w celu wykonywania bloku kodu na innym serwerze. Warto również wspomnieć, iż RPC używane za pośrednictwem HTTP może przekształcić się w WEB AP
Poniżej przykład korzystania z SOAP API przy użyciu języka python.
potrzebne narzędzia:
requests – Jedna z najpopularniejszych bibliotek pythona wykorzystywana do komunikacji z API. W celu skorzystania z biblioteki należy ją zaimportować w kodzie:
Następnie należy zdefiniować SOAP url podany w dokumentacji API:
Należy zdefiniować nagłówki, jako słownik i przypisać do zmiennej headers
Nagłówek SOAP służy do włączenia właściwych dla aplikacji informacji o kontekście w żądaniu SOAP
Następnym i najważniejszym krokiem jest definicja ciała żądania XML. model ciała żądania dostępny jest pod adresem SOAP url. Należy określić wymagane parametry i wpisać potrzebne dane. Ciało żądania przypisane jest do zmiennej payload:
Wywołanie metody POST oraz przypisanie odpowiedzi z API do zmiennej response:
