API Dokumentácia
API (application programming interface) Vám umožní pomocou jednotlivých metód vykonávať rôzne dotazy (napríklad poslať SMS).
Pre získanie prístupu k API je potrebné mať aktívny plán Professional, na ktorý je tento produkt viazaný a následne navštíviť sekciu Obchod. V obchode je potrebné zakúpiť si jeden z produktov API, ktorý si prajete využívať.
Po úspešnej platbe sa Vám vygeneruje token (unikátny identifikátor), ktorý nájdete v sekcii API. V tejto sekcii taktiež nájdete všetky potrebné informácie o používaní tokenu.
Token symbolizuje unikátny identifikátor, vďaka ktorému môžete využívať API produkty, ktorý využívate pri volaní metódy API (napr. pri volaní metódy zasielania SMS správ zadáte aktuálny token na overenie, či je daný API produkt aktívny a je možné metódu vykonať).
V prípade straty alebo odcudzenia tokenu, máte v sekcii API možnosť 3x manuálne si pregenerovať token. Po kliknutí na dané tlačidlo, v tabuľke tokenov pribudne novo-vygenerovaný token, ktorý bude označený zelenou farbou. Tento token je následne aktívny a všetky ostatné strácajú platnosť (označené červenou farbou).
Nájdete tu tiežstav Vášho tokenu a momentálny stav použitia tokenu.Každý produkt (napríklad API SMS) má určený limit volaní, čo znamená, že pri každom volaní APImetódy si vyčerpáte 1 volanie. Pri dovŕšení limitu už nie je možné volať API metódu a je potrebné si zakúpiť nový API produkt, čím získate nový limit.
Ako volať API metódy:
Posielanie SMS
(Metóda pomocou ktorej je možné posielať SMS je typu POST, pri ktorej zadávate serveru dáta, ktoré on spracuje a vráti Vám nejakú odozvu.)
Http metóda
POST
Metódu zavoláte v Rest klientovi ako napríklad POSTMAN.
Do requestu je pre poslanie SMS nutné zadať nasledujúci riadok:
https://api.marketlocator.com/api/message/Sendmessage
Taktiež treba nastaviť request na typ POST.
Pred zavolaním metódy Sendmessage je treba zadať vstupné paramatre pre túto metódu.
Tieto parametre zadáme do sekcie body a header.
V sekcii headers – autorizácia, zadáme už spomínaný token, a to vo forme:
API hlavička (request headers)
Content-Type :
Token{…}.V zátvorkách bude Váš token.
Príklad: Token {7B61CA1D-29AA-412C-8442-8E9C4B3CB0CF}
V sekcii headers-Content-Type zadáme: application/json
Nasleduje napísanie samotnej správy a určenie čísel na ktoré sa má SMS poslať.
Tieto údaje zadáme do sekcie Body vo forme:
{
"message": "text of SMS",
"to": ["number1"],
"from": "sender name"
}
Example:
{
"message":"Hello. This is an SMS from James.",
"to": ["0948283897",”0913564489”,”0917586493”],
"from":"James"
}Číslo/Meno odosielateľa musí byť totožné s jedným z mien v sekcii Nastavenia – Mená odosielateľa kampane.
Počet čísiel na ktoré je SMS v jednom volaní posielaná je 10.
Po zadaní všetkých potrebných parametrov je zavoláme metódu Sendmessage, ktorá vráti nejakú odozvu.
Odozvy volania API
Pri úspešnom odoslaní SMS sa Vám objaví Id volania SMS, ktoré môžete použiť pri dohľadaní bližších informácii o priebehu odoslania SMS.
V prípade zadanie zlého formátu čísla, sa pod názvom skipped objaví počet nevalidných čísiel,na ktoré v danom requeste nebola poslaná SMS.
Code samples
C#:
var client = new RestClient("https://api.marketlocator.com/api/message/Sendmessage ");
var request = new RestRequest(Method.POST);
request.AddHeader("cache-control", "no-cache");
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Token {{token}}");
string body =
"{" +
"\"message\":\"{message}\"," +
"\"to\": [\"{phoneNumber}\"]," +
"\"from\":\"{senderName}\"" +
"}";
request.AddParameter("undefined",body}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);Java:
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
string body =
"{" +
"\"message\":\"{message}\"," +
"\"to\": [\"{phoneNumber}\"]," +
"\"from\":\"{senderName}\"" +
"}";
RequestBody body = RequestBody.create(mediaType,body);
Request request = new Request.Builder()
.url("https://api.marketlocator.com/api/message/Sendmessage ")
.post(body)
.addHeader("Authorization", "Token {{token}}")
.addHeader("Content-Type", "application/json")
.addHeader("cache-control", "no-cache")
.build();
Response response = client.newCall(request).execute();Javascript:
var settings = {
"async": true,
"crossDomain": true,
"url": " https://api.marketlocator.com/api/message/Sendmessage ",
"method": "POST",
"headers": {
"Authorization": "Token {{token}}",
"Content-Type": "application/json",
"cache-control": "no-cache",
},
var body =
"{" +
"\"message\":\"{message}\"," +
"\"to\": [\"{phoneNumber}\"]," +
"\"from\":\"{senderName}\"" +
"}",
"processData": false,
"data": body
}
$.ajax(settings).done(function (response) {
console.log(response);
});PHP:
$request = new HttpRequest(); $request->setUrl(https://api.marketlocator.com/api/message/Sendmessage); $request->setMethod(HTTP_METH_POST); $request->setHeaders(array( 'cache-control' => 'no-cache', 'Content-Type' => 'application/json', 'Authorization' => 'Token {{token}}' )); $request->setBody('{ "message":"{message}", "to": ["{phoneNumber}"], "from":"{senderName}" }'); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; }
Python:
import http.client
conn = http.client.HTTPConnection("api,marketlocator,com")
payload = "{" +
"\"message\":\"{message}\"," +
"\"to\": [\"{phoneNumber}\"]," +
"\"from\":\"{senderName}\"" +
"}",
headers = {
'Authorization': "Token {{token}}",
'Content-Type': "application/json",
'cache-control': "no-cache",
}
conn.request("POST", "api,message,Sendmessage", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
