Podrobný popis API

Věta A - typ call

Vlastnost Popis Povinné Poznámka
Hlavička
InterfaceID Identifikátor Rozhraní (Interface) v podobě int-xxx-xxx  A Tento identifikátor interface je generován systémem Maatrix v okamžiku, kdy aplikační partner založí v tomto systému nové rozhraní / interface
MessageType Typ zprávy = call  A  
ServiceID Identifikátor služby v podobě srv-xxx-xxx  A  
M2Mpswd M2M (machine to machine) heslo pro přístup interface k systému A M2M heslo je náhodně generováno systémem Maatrix. Správce služby má možnost kdykoli vygenerovat nové heslo a to je pak následně nutné upravit i v externí aplikaci
ExternalID Externí ID daného volání služby (přiděleno volající externí aplikací)  N Nepovinný externí identifikátor. Max 50 alfanumerických znaků, včetně mezer, podtržítek, pomlček. Systém Maatrix jej nijak nezpracovává. Pokud je ExternalID zadáno, bude jednoduše vráceno ve všech relevantních zprávách, které systém posílá vnějšímu světu
SendSummary Požadujeme po Maatrixu, aby generoval a poslal souhrnnou zprávu po ukončení služby? 1=ano, 0=ne  A  
SummaryChannel Komunikační kanál, kterým bude zaslána závěrečná zpráva X-summary, pokud je požadována  N

Hodnotou jsou následující údaje:

Format: "json"

EmailRecipient: mailová adresa, na kterou má být zpráva X zaslána.

Pokud je zadán SendSummary=1 a v SummaryChannel není žádná hodnota, je vracena zpět zpráva dle typu interface (např. json) a na mailovou adresu, ze které přišla zpráva A (platí jen u smtp adapteru)

Vstupní parametry služby
InputParameters Pole s jednotlivými vstupními parametry v závislosti na zvolené komunikační službě   Názvy jednotlivých vstupních parametrů jsou klíčem tohoto pole, hodnota je závislá na typu vstupního parametru.
<:Parameter> Jednotlivé vstupní parametry volané služby. Názvy parametrů musí být uvedeny včetně povinného uzavření mezi "<: a >" A Věta A musí obsahovat všechny vstupní parametry volané služby. Seznam těchto parametrů je k dispozici v portálu systému Maatrix u nastavení služby. Význam jednotlivých typů vstupních parametrů naleznete zde.
<:Caller> Jediný nepovinný vstupní parametr - Emailová adresa uživatele, který službu v externí aplikaci inicioval  N Nepovinný údaj. Pokud je uveden, musí být tento uživatel v systému Maatrix zaregistrován a musí mít k volané službě oprávnění k vyvolání služby