Po co potrzebne jest API
API (Application Programming Interface) — to funkcjonalność do interakcji między różnymi programami. Dla człowieka istnieją osobne interfejsy, na przykład witryna. API jest potrzebne do różnych integracji. Sender Solutions ma API, które działa za pomocą żądań HTTP w formacie JSON. Dostęp do API jest udostępniany dla wszystkich planów taryfowych projektu, w tym również na bezpłatnym planie taryfowym. Możesz używać API Sender Solutions do pełniejszej i bardziej elastycznej integracji. Przewidywany format korzystania z API — z Twojej witryny na podstawie wyzwalaczy. Na przykład, gdy w Twojej witrynie tworzony jest subskrybent, witryna wykonuje żądanie API, i subskrybent z analogicznymi danymi jest tworzony w Sender Solutions.
Rozpoczęcie korzystania z API
- Aby korzystać z API, musisz utworzyć projekt w Panelu osobistym Sender Solutions.
- Następnie na stronie ustawień projektu utwórz klucz API. To unikalny klucz dostępu do API na poziomie tego projektu. Przechowuj go w tajemnicy. Jeśli istnieje podejrzenie, że klucz został skompromitowany, jak najszybciej zacznij używać nowego klucza, a skompromitowany klucz dezaktywuj lub usuń.
- Dla jednego projektu można tworzyć kilka kluczy API — wszystkie są równorzędne. Może to być przydatne, jeśli masz kilka różnych aplikacji, które będą wykonywać żądania API.
- Klucz API należy przekazywać w nagłówku HTTP Authorization.
- Treść żądania przekazuj w formacie JSON, a w nagłówku Content-Type wskaż wartość application/json.
- Kieruj się statusem HTTP odpowiedzi. Jeśli kod 200 — wszystko przebiegło pomyślnie. Jeśli kod 500 — wystąpił błąd.
- Odpowiedź z API w ogólnym przypadku zwracana jest w formacie JSON. Na poziomie głównym obecny jest klucz "success" z możliwymi wartościami true / false.
Przykład pomyślnej odpowiedzi:{
"success": true
}
Przykład odpowiedzi z błędem:{
"error": "Some error description",
"success": false
}
W treści pomyślnej odpowiedzi mogą być dodatkowe dane w zależności od konkretnego żądania. - Do pracy z API nie jest potrzebna obsługa cookies ani sesji.
Przydatne zasoby
Composer pakiet do pracy z API w php: sender-solutions/php-sdk oraz ten sam pakiet na github: Sender-Solutions/php-sdk
Postman kolekcja żądań do API jest dostępna pod linkiem