Przejdź do treści

API dla programistów: od czego zacząć

Aktualizacja:

Na tej stronie

API to sposób, w jaki Twój program sam „klika” w SMS Portal|app zamiast Ciebie. Zamiast wpisywać numer w panelu, program wysyła krótkie żądanie, a wiadomość wychodzi z Twojego telefonu z Androidem, z Twojej karty SIM.

Pierwsze wywołanie

  1. W panelu otwórz sekcję Klucze API i kliknij „Wygeneruj klucz API”. Skopiuj klucz od razu: później już go nie zobaczysz.
  2. Upewnij się, że masz podłączony telefon z aplikacją.
  3. Wyślij żądanie POST na https://smsportal.app/api/v1/gateway/send-sms. Klucz podaj w nagłówku x-api-key, a w treści JSON z listą numerów (recipients) i tekstem (message).
sh
curl -X POST https://smsportal.app/api/v1/gateway/send-sms \
  -H "x-api-key: TWÓJ_KLUCZ_API" \
  -H "Content-Type: application/json" \
  -d '{"recipients": ["+48123456789"], "message": "Test z API"}'

Zamień klucz i numer na własne. Numer podaj w pełnym formacie z numerem kierunkowym kraju.

Gdzie jest reszta

  • Dokumentacja API. Pod adresem /api-docs/ jest pełna lista adresów: wysyłka pojedyncza i zbiorcza, lista telefonów, historia wiadomości, statystyki i webhooki. Każdy adres ma opis i przykłady.
  • Instrukcja w panelu. W zakładce Wiadomości → API znajdziesz krótką instrukcję z gotowymi przykładami.
  • Odbieranie odpowiedzi. Żeby Twój program dostawał SMS-y od klientów, użyj webhooków.

Zadbaj o klucz

Klucz API działa jak hasło do wysyłki z Twojego konta. Nie wklejaj go do kodu, który trafia do publicznego repozytorium. Gdy podejrzewasz wyciek, unieważnij klucz w panelu i wygeneruj nowy. Więcej w artykule o kluczach API.

Co dalej

Pytania i odpowiedzi

Skąd wziąć klucz API?
Z panelu, w sekcji Klucze API. Po wygenerowaniu klucz widać tylko raz, więc skopiuj go od razu i schowaj w bezpiecznym miejscu.
Czy sama odpowiedź API oznacza, że SMS dotarł?
Nie. Odpowiedź mówi, że wiadomość przyjęto do wysłania. Faktyczny status sprawdzisz w historii w panelu albo odbierzesz go webhookiem.

Nie znalazłeś odpowiedzi? Napisz do nas

Wyślij pierwszego SMS-a jeszcze dziś

Załóż darmowe konto, podłącz telefon i sprawdź, jak klienci reagują na wiadomości z Twojego numeru.