Přeskočit na hlavní obsah

Přechod na JSON API z HTTP API

Přechod na JSON API​

Plnohodnotné JSON API nebo zjednodušené metody API?​

Pokud používáte http-api a preferujete jednodušší API, lze použít metody simple/message kde lze do větší míry také zachovat existující formáty zasílání dat.

Typ APIVýhodyNevýhody
JSON APIVšechny funkce (vč. hromadného odesílání, podpora dalších kanálů jako WhatsApp, Viber a další)Požadavky je nutné sestavovat jako POST a zasílat JSON dokument
Zjednodušené metody JSON APIJednodušší na implementaci (lze zachovat část existujícího kódu)Nelze odesílat více zpráv najedno, podporuje pouze odesílání SMS

GET/POST http-api.smsmanager.cz​

Pokud jste dříve používali http-api.smsmanager.cz a to formou GET nebo POST požadavků, můžete použít následující postup pro přechod na JSON API a zjednodušené metody API:

Přechod na zjednodušené metody API​

Přechod na POST

Při přechodu na tyto zjednodušené metody doporučujeme použít zasílání POST požadavku namísto GET.

1) Změna endpointu​

Nejprve změníte http-api.smsmanager.cz na api.smsmngr.com/v2/simple/message.

2) Změna parametrů​

Změna použití API klíče

Pro GET požadavky je API klíč nutné předat pomocí parametru apikey.
Pro POST požadavky je API klíč nutné předat pomocí hlavičky x-api-key.

Názvy parametrů GET/POST požadavku jsou nyní dle dokumentace následující (doporučujeme použít tyto nové názvy):

  • apikey
  • phone_number
  • body
  • sender
  • gateway
  • datetime
  • type

V každém případě, z důvodu zachování kompatibility, je možné použít i původní názvy parametrů: apikey, number, message, sender, gateway, time, type.

3) Zpracování odpovědi​

Odpověď se nyní vrací v JSON formátu:

{
  "request_id": "1234567890",
  "message_id": "1234567890",
  "accepted": true
}