{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"b565b990-c096-44db-858b-1cbafa0ee8e8","name":"WebToLearn API","description":"# Przegląd\nApi zostało napisane zgodnie z architekturą REST i pozwala na komunikację z systemem WebToLearn.pl. \nDostęp do API jest możliwy poprzez użycie `API Token` dostępnego w ustawieniach administracyjnych portalu (`Panel administracyjny -> Konfiguracja Platformy -> API`). \nWszystkie żądania API wykonywane są przez adres Twojej platformy w adresie *.elms.pl lub w Twojej własnej (jeśli masz podpiętą pod nasz system np. kursy.twojadomena.pl): \n`{platforma}.elms.pl/api/v1/` lub `{twojadomena}/api/v1/`. \nAPI zwraca odpowiedzi w postaci `application/json`\n\n\n# Autoryzacja\nAutoryzacją objęte są wszystkie endpointy opisane w niniejszej dokumentacji. Uwierzytelnianie wymaga użycia nagłówka `X-Auth-Token` oraz `API Token` jako wartości, który jest dostępny w `Panel administracyjny -> Konfiguracja Platformy -> API` w danej platformie. \n\n# Kody błędów\nAPI obsługuje standardowe kody błędów:\n\n`402` - wymagana płatność. Błąd pokazywany przy wygaśnięciu abonamentu (WebToLearn) oraz przy przekroczeniu limitu użytkowników platformy w tymże abonamencie\n\n`403` - brak dostępu - błędny `API Token`\n\n`404` - nie znaleziono zasobu\n\n`400` - błędne żądanie\n\n`429` - wykorzystany limit API.\n\n`201` - OK. Brak treści\n\n`200` - OK\n\n\nPrzy większości błędów dodatkowo dostaniesz szczegółową odpowiedź w postaci obiektu ze statusem oraz kodem odpowiedzi:\n```\n{\n  \"Status\": [ \"message\": \"You have reached your API call limit\"],\n  \"Code\" 429\n}\n```\n\n# Rate limit\nW celu zabezpieczenia API wykorzystujemy system API Rate Limiter w celu zapobiegania przeciążenia systemu. Domyślne wartości limitów to:\n- **3600** w ciągu godziny\n- **360** w ciągu minuty.\n\nFaktycznie przyznane limity oraz ilość pozostałych do wykorzystania requestów znajdziesz w nagłówkach odpowiedzi:\n`X-RateLimit-Remaining-Hour`,\n`X-RateLimit-Remaining-Minute`,\n`X-RateLimit-Limit-Hour`,\n`X-RateLimit-Limit-Minute`.\n\nJeśli potrzebujesz wyższych limitów skontaktuj się z obsługą klienta.\n\n# Zasada budowania adresów do pobierania list [GET]\nKażda lista posiada możliwość paginacji, sortowania oraz filtrowania. Wszystko odbywa się poprzez ustawienie odpowiedniego parametru w adresie. \n\n## Paginacja\nDo sortowania jest wykorzystywany parametr `range`, który jako wartość przyjmuje tablicę `limit,offset`\n\nW nagłówkach odpowiedzi znajdziesz `Content-Range`, który w wartości zwróci: `nazwę zasobu offset-limit/całkowita ilość` przykładowo:\n\n\n`Content-Range: trainings 0-11/2`\n\n## Sortowanie \nDo filtrowania wykorzystywany jest parametr `sort`, który przyjmuje tablicę:`[field, direction]`. Pola po których można sortować są opisane w poszczególnych endpointach. Możliwe są następujące sortowania: `ASC` oraz `DESC`\n\nPrzykład użycia:\n\n`sort=[\"id\", \"DESC\"]`\n\n## Filtrowanie\nDo filtrowania wykorzystywany jest parametr `filter`, który przyjmuje tablicę obiektów:\n\n```\n[\n  {\n    \"field\": \"nazwapola\",\n    \"type\": \"typ filtrowania\",\n    \"value\": \"wartość filtra\"\n  }\n]\n```\n\nWszystkie dostępne pola filtrowania są opisywane w poszczególnych endpointach. \n\n### Typy filtrów\nWyróżniamy następujące typy filtrów, które według nazwy odpowiadają składni SQL:\n- `equals` \n- `in` \n- `not in`\n- `exists`\n- `contains`\n- `less`\n- `more`\n- `more_equals`\n- `less_equals`\n- `is`\n\n### Przykład:\n`filter=[{\"field\": \"name\", \"type\": \"contains\", \"value\": \"drugie\"}]`","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"17141869","team":2371827,"collectionId":"b565b990-c096-44db-858b-1cbafa0ee8e8","publishedId":"TzzDLb4k","public":true,"publicUrl":"https://documenter-api.postman.tech/view/17141869/TzzDLb4k","privateUrl":"https://go.postman.co/documentation/17141869-b565b990-c096-44db-858b-1cbafa0ee8e8","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2021-08-23T13:42:42.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/272d34e129f65e3db8b66fa2b231f37bd60b0f5a37b6bc41b08ad87763dcb861","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/TzzDLb4k"}