HTTP metody pro REST API
GET čtení dat
POST nové záznamy (zápis)
PUT modifikované záznamy (editace)
DELETE mazání dat
Swagger dokumentace z našeho demo serveru je dostupná na http://demo.moneys5.cz:81/swaggerDoc/.
Pro údaje ClientID a ClientSecret si zažádejte pomocí formuláře.
HTTP návratové kódy
| Kód | Status | Popis | Příčina chyby |
| 200 | OK | operace proběhla úspěšně | – |
| 400 | Bad Request | špatně sestavený dotaz | syntaktická chyba |
| 401 | Unauthorized | chyba autorizace | chybějící nebo neplatný token |
| 403 | Forbidden | chyba autentizace | nedostatečná uživatelská práva (v Money Sx) |
| 404 | Not Found | nenalezeno | nesprávná adresa endpointu, nedostupný server |
| 415 | Unsupported Media Type | nepodporovaný formát | požadavek zaslán ve formátu, který není podporován (např. nesprávný Content-Type) |
| 500 | Internal server error | interní chyba serveru | konkrétní popis chyby v těle odpovědi |
Parametry requestu
Content-type
Autorizace application/x-www-form-urlencoded
Běžný request application/json
Stránkování
Pro stránkování přijatých dat se používají (path) parametry:
from počet položek, které se mají přeskočit
count požadovaný počet položek, které se mají vrátit
Response objekt
Vlastnosti wrapper objektu, který je součástí odpovědi zaslané S5API:
Data vlastní obsah (data)
RowCount celkový počet záznamů v db (odpovídajících danému requestu)
PageCount počet stránek (odpovídajících danému requestu) pokud je počet záznamů v DB (odpovídajících
danému requestu) vyšší, než stanovený limit, je vrácen pouze počet záznamů odpovídající tomuto
limitu, přičemž ageCount udává, do kolika requestů musí uživatel požadavek rozdělit, aby (po
agregaci) získal veškerá požadovaná data
Message chybová hláška
StackTrace obsahu paměťového zásobníku (stack) v okamžiku, kdy nastala chyba
Status stav odpovědi [OK = 1, Warning = 2, Error = 3)]
Dostupné entity
REST API
| Doklad/Objekt | Endpoint | čtení | zápis | mazání | generování pdf |
| Aktivita | Activity | x | x | x | |
| Artikl (katalog) | Article | x | x | x | |
| Bankovní výpis | BankStatement | x | x | x | |
| Ceníková cena | PriceList | x | x | x | x |
| Činnost | Operation | x | x | x | |
| Faktura přijatá | ReceivedInvoice | x | x | x | x |
| Faktura vydaná | IssuedInvoice | x | x | x | x |
| Firma | Company | x | x | x | |
| Objednávka přijatá | ReceivedOrder | x | x | x | |
| Objednávka vydaná | IssuedOrder | x | x | x | |
| Osoba | Person | x | x | x | |
| Pracovník | Staff | x | x | x | |
| Servisní doklad | Service | x | x | x | x |
| Spojení | Connection | x | x | x | |
| Středisko | Centre | x | x | x | |
| Typ aktivity | TypeOfActivity | x | x | x | |
| Zakázka | JobOrder | x | x | x | |
| Zálohová faktura přijatá | PrepaymentInvoice | x | x | x | x |
| Zálohová faktura vydaná | PrepaymentIssuedInvoice | x | x | x | x |
Další vývoj REST API bude již jen v udržovacím režimu. Další endpointy pro REST API již nebudou přidávány. Výčet endpointů pro REST API je viz výše nebo v swagger dokumentaci.
Další vývoj bude směřován do technologie GraphQL. Základní přehled endpointů pro GraphQL je v následující tabulce (údaj k verzi 1.13.1).
Seznam všech aktuálních enpointů naleznete v přehledu z našeho demo serveru.
GraphQL
| Doklad/Objekt | GraphType | čtení | zápis | editace | mazání | |
| Artikl (katalog) | Article | x | x | x | x | ve vývoji |
| Artikl kategorie | ArticleCategory | x | x | x | x | |
| Artikl parametry | ArticleParameter | x | x | x | x | |
| Artikl rozměry | ArticleSize | x | x | x | x | |
| Ceník | PriceList | x | x | x | x | |
| Ceníková cena | PriceListItem | x | x | x | x | |
| Činnost | Operation | x | x | x | x | |
| Druh zakázky | JobOrder | x | x | x | x | |
| Číselník jednotky | Unit | x | x | x | x | |
| Faktura vydaná | IssuedInvoice | x | x | x | x | |
| Položka fakt. vydané | IssuedInvoiceItem | x | ||||
| Firma | Company | x | x | x | x | |
| Měna | Currency | x | x | x | x | |
| Objednávka přijatá | ReceivedOrder | x | x | x | x | |
| Položka obj. přijaté | ReceivedOrderItem | x | ||||
| Reklamace přijatá | ReceivedComplaint | x | x | x | x | |
| Pol. rek. přijaté | ReceivedComplaintItem | x | ||||
| Sklad | Warehouse | x | x | x | x | |
| Skladová zásoba | WarehouseStock | x | x | x | x | |
| Stav dokladů | WorkflowDefState | x | ||||
| Stav zakázky | JobOrderState | x | x | x | x | |
| Středisko | Centre | x | x | x | x | |
| Zakázka | JobOrder | x | x | x | x | |
| Způsob dopravy | TransportType | x | x | x | x | |
| Způsob platby | PaymentType | x | x | x | x | |
| Eshop+ objecty | Esh_ | x | ||||
| Další.. | … | .. | .. | .. | .. |
Od verze 1.13.1. jsou dostupné i endpointy pro E-shop konektor plus. Uživatelské sloupce jsou dostupné pouze pro GraphQL od verze 1.13.2.