{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"b6a6c9b4-b9cc-47fb-b767-f12b1d1c666e","name":"Darujme API v2","description":"## Identikátory\n\nPre schovanie reálneho počtu záznamov v internej databáze, aplikačné rozhranie používa na identifikáciu prostriedkov\n[UUID4](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random)) reťazce.\n\n## Schéma\n\nVšetky požiadavky na API by mali byť volané pomocou HTTPS protokolu.\n\nTelá požiadaviek sú v [JSON](http://www.json.org) formáte, kódované v UTF-8. Každá odpoveť obsahuje `metadata` objekt,\nktorý obsahuje doplnujúce informácie k požiadavke ako je napríklad paginácia, dĺžka vykonávania scriptu na strane\nservera a podobne. Na pomenovávanie premenných sa používa [snake_case](https://en.wikipedia.org/wiki/Snake_case)\nkonvencia (názvy premenných a funkcií su malými písmenami a ako oddelovač slov sa používa podčiarnik `_`).\n\nAPI môže prijať/odoslať aj prázdne hodnoty pomocou správne použitej `null` hodnoty, podľa JSON špecifikácie.\n\n`Content-type: application/json` a `Accept: application/json` hlavičky by mali byť v každej požiadavke ak nie je\nšpecifikované inak.\n\n### HTTP metódy\n\n| HTTP metóda | Popis                                   |\n|-------------|-----------------------------------------|\n| `GET`       | Získanie prostriedku.                   |\n| `POST`      | Vytvorenie alebo upravenie prostriedku. |\n| `PUT`       | Upravenie prostriedku.                  |\n| `DELETE`    | Odstránenie prostriedku.                |\n\n### Status kódy\n\nAPI vracia príslušné HTTP kódy na informovanie o úspešnosti/stave požiadavky.\n\n| HTTP kód          | Popis                                                                             |\n|-------------------|-----------------------------------------------------------------------------------|\n| `200` `201` `204` | Operácia bola úspešne vykonaná.                                                   |\n| `401`             | Nepodarilo sa autorizovať používateľa (zlé meno a heslo, neprihlásený používateľ).|\n| `403`             | Prístup odopretý. Používateľ nemá právo na vykonanie akcie.                       |\n| `404`             | Žiadaný prostriedok neexistuje                                                    |\n| `422`             | Validačná chyba spolu s opisom.                                                   |\n| `500`             | Interná chyba na strane servera (skúste neskôr).                                  |\n\nAPI môže vrátit aj status kódy mimo spomenutých v tabuľke vyššie. V tom prípade sú kódy platné podľa\n[List of HTTP status codes](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes).\n\n## Autentifikácia\n\nEntita, ktorá žiada o prístup k prostredkom aplikačného rozhrania je `User`, ktorý sa overuje pomocou tokenu, ktorý\nvymení za svoje prihlasovacie meno a heslo.\n\nPre zabezpečenie čo najväčsej flexibility (hlavne pri pridelovaní právomocí na prístup k prostriedkom), každá HTTP\npožiadavka (v prípade že nie je uvedené inak) musí obsahovať nasledujúce hlavičky (hodnoty sú ilustračné):\n\n- `X-ApiKey: 199d2aaa-0405-49c1-a171-27aeabd6c1ac`: Identifikátor API kľúča (ďalej ako `ApiKey`)\n- `X-Signature: c8849f0b8a96a41edfe949e574d561ab883cc9971725c7dbf16a4e086f40c19b`: Podpis\n- `X-Organisation: d8a22a60-ef2c-4fbf-b355-a1bdb6772feb`: Identifikátor organizácie\n- `Authorization: TOKEN 08bcd06c-3ad5-48d9-bfc6-5238d97ba7c6`: Prístupový token (`Token`, patrí `User`)\n\n### API kľúče\n\nPre prístup k API je nevyhnutné mať platný API klúč, ktorý identifikuje zdroj požiadavky. Kľúče sú generované pre\norganizácie a každá klientská aplikácia (napr. Web alebo aplikácie tretích strán) má svoj vlastný. Pre každý ApiKey\nexistuje aj `secret`, ktorý sa používa na výpočet podpisu `X-Signature`.\n\n### Podpisovanie\n\nPre zachovanie čo najväčšej úrovanie zabezpečenia, každá aplikácia musí byť podpísaná nasledujúcim algoritmom\n(prvy argument je `payload` a druhý `secret`):\n\n`HMAC_SHA256(BODY:URI, APIKEY_SECRET)`\n\nPríklad vytvorenia podpisu v jazyku Python:\n\n```python\nimport hashlib\nimport hmac\n\n# {\"bla\": \"real content\"}:/v1/endpoint/\npayload = f\"{request.body.decode('utf-8')}:{request.path}\"\nsecret = \"{y}Bq_jX}f78?A83\"\nsignature_check = hmac.new(\n    secret.encode('utf-8'),\n    msg=payload.encode('utf-8'),\n    digestmod=hashlib.sha256\n).hexdigest()\n```\n\nPodpis sa musí nachádzať v HTTP hlavičke `X-Signature`.\n\n### Token\n\nToken je reprezentovaný entitou `Token`, ktorá patrí entite `User` a používateľ ju získa výmenou za svoje prihlasovacie\núdaje (meno a heslo). Používa sa priradenie používateľa požiadavke a zistovanie oprávnení na prístup k prostriedkom.\n\nProces získania tokenu je opísaný nižšie spolu s definíciou end-pointov.\n\nToken sa musí nachádzať v každe požiadavke vHTTP hlavičke `Authorization` ak nie je uvedené inak.\n\n## Čas a dátum\n\nVšetky časové údaje sa musia byť formátované v platnom [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601):\n`YYYY-MM-DDTHH:MM:SSZ`.\n\n## Formát odpovede\n\nKaždá odpoveť API obsahuje `metadata` objekt, ktorý nesie dodatočné informácie o požiadavke. Principiálne sa jedná\no informácie o stránkovaní a dlžke vykonávania scriptu na strane servera. Iné špecifické hodnoty, ktoré može objekt\nnadobúdať sú prípadne definové pre k danému end-pointu zvlášť.\n\n- `page`: číslo aktuálnej stránky indexované od 1\n- `limit`: maximálny počet elementov na stránke\n- `pages`: celkový počet stránok\n- `total`: celkový počet položiek na všetkých stránkach\n\n### Odpoveď s výsledkom\n\n```json\n{\n  \"response\": {\n    \"token\": \"PRETTY_AWESOME_TOKEN\"\n  }\n}\n```\n\n### Odpoveď so stránkovaným výsledkom\n\n```json\n{\n  \"items\": [\n    {\n      \"title\": \"Pigs\",\n      \"artist\": \"Pink Floyd\"\n    },\n    {\n      \"title\": \"Wish you were here\",\n      \"artist\": \"Pink Floyd\"\n    }\n  ],\n  \"metadata\": {\n    \"page\": 1,\n    \"limit\": 2,\n    \"pages\": 14,\n    \"total\": 28\n  }\n}\n```\n\n### Chyba\n\nAk status kód odpovede nie je `2xx` jedná  sa o chybu, ktorá ak nie je špecifikovaná inak je zapísaná v nasledovnom\nformáte:\n\n```json\n{\n  \"error\": {\n    \"message\": \"Invalid permissions!\",\n    \"trace\": {}\n  }\n}\n```\n\n### Validačná chyba\n\nAk je status kód HTTP odpoveďe `422` jedná sa o validačnú chybu, čo znamená, že požiadavka bola poslaná na server v s\nnevalidnými dátami. V tomto prípade vyzerá odpoveď nasledovne (ak nie je pre end-point špecifikované inak):\n\n```json\n{\n  \"errors\": [\n    {\n      \"field\": \"email\",\n      \"details\": [\n        {\n          \"message\": \"Invalid format!\"\n        },\n        {\n          \"message\": \"Must contain a number.\"\n        }\n      ]\n    }\n  ]\n}\n```\n\nKaždá hodnota, ktorú server označil ako nevalidnú ma priradený objekt v poli `errors`.\n\n## Filtrovanie\n\nKaždý stránkovaný end-point akcpeptuje nasledujúce GET atribúty:\n\n- `limit`: Maximálny počet položiek na jednej stránke\n- `page`: Číslo stránky, ktorú má API vrátit.\n\nDalšie filtračné atribúty sú dostupné v konkrétnych kolekciách.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"10150431","collectionId":"b6a6c9b4-b9cc-47fb-b767-f12b1d1c666e","publishedId":"T1LS9jWA","public":true,"publicUrl":"https://documenter-api.postman.tech/view/10150431/T1LS9jWA","privateUrl":"https://go.postman.co/documentation/10150431-b6a6c9b4-b9cc-47fb-b767-f12b1d1c666e","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.0","publishDate":"2020-08-18T10:50:20.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/T1LS9jWA"}