{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"036c3fc1-9f2a-aa9f-790c-f5ac7cf1dd66","name":"GBooking API для онлайн-записи","description":"GBooking API — это стандартный json-rpc2 api,  поддерживающий множество операций управления данными бизнеса, клиентов, предоставления статистики, бронирования времени и многое другое. Он проверяет acl роли пользователя для каждого запроса через параметры ```` \"cred\": {\"user\": \"...\", \"token\": \"...\"} ````. \n\nВ данной документации представлены примеры запросов для тестового окружения. Вы можете выполнять их при разработке.\n\nПример запроса:\n````\n{\n   \"jsonrpc\":\"2.0\",\n   \"id\":1,\n   \"method\":\"business.get_top_services\",\n   \"params\":{\n      \"business\":{\n         \"id\":\"4000000001992\"\n      }\n   },\n   \"cred\":{\n      \"token\":\"...\",\n      \"user\":\"...\"\n   }\n}\n````\n\n* __jsonrpc__ — версия протокола (2.0)\n* __id__ — значение числового типа для идентификации запроса на сервере\n* __method__ — название вызываемого метода\n* __params__ — массив параметров для вызываемого метода\n* __cred__ — набор данных для идентификации и авторизации\n\n\nПример успешного ответа:\n````\n{\n    \"jsonrpc\": \"2.0\",\n    \"id\": 1,\n    \"result\": {\n        \"status\": true,\n        \"services\": []\n    }\n}\n````\n\nПример ответа с ошибкой:\n````\n{\n   \"jsonrpc\":\"2.0\",\n   \"id\":1,\n   \"error\":{\n      \"code\":-10200,\n      \"message\":\"Failed to retrieve business\",\n      \"data\":\"\"\n   }\n}\n````\n\nВсе запросы по уровню доступа разделяются на несколько базовых ролей:\n* __guest__ — публичный запрос без указания параметров доступа\n* __client__ — запрос предоставляет, управляет данными конкретного клиента\n* __admin__ — запрос имеет доступ к данным бизнеса или некоторого набора бизнесов\n\nДля каждого запроса указана его роль доступа в описании. Возможно несколько ролей доступа. В этом случае запрос возвращает различную информацию.\n\nДля онлайн-записи используются публичные методы* с ролью _guest_.\n\n----\n_* за исключения метода резервирования записи через витрину. В этом случае самый простой способ авторизации — это получить long live token в Бэкофисе витрины._\n\n\n## Глоссарий\n\nВ основе _GBooking API для онлайн записи_ лежит несколько сущностей:\n* __Бизнес__ содержит полные данные о бизнесе:\n\t* список работников\n\t* список услуг\n\t* настройки отображения виджета GBooking\n\t* настройки отображения БекОфиса GBooking\n\t* информацию о бизнесе (название, адрес, телефон, график работы)\n\t* список других филиалов сети\n* __Бизнес-филиал__, __Филиал__ представляет данные одного отделения, филиала, торговой точки, салона и т.д. \n* __Бизнес-витрина__, __Витрина__ представляет доступ к данным произвольного набора бизнесов-филиалов\n* __Сеть филиалов__ — набор бизнесов-филиалов, объединённых в одну сущность. На виджете GBooking пользователь может перейти из одного филиала на другой или получить данные по всем филиалам. В Бекофисе администратор, обладающий достаточными правами, сможет переключаться между филиалами. Данные по клиентам в сети филиалов общие.\n* __Работник__ содержит данные работника:\n\t* полное имя\n\t* список услуг, которые он выполняет\n\t* скорости выполения услуг\n\t* отделение\n\t* телефон, email\n\t* дополнительную текстовую информацию — профессию, описание работника\n* __Услуга__, __Таксономия__ — услуга или категория услуг, на которую можно записаться. Содержит название, описание, длительность (опционально для каждого работника), цена, скидки.\n* __Слот расписания__ — временной интервал, на который возможна запись\n* __Запись__ — сущность в расписании, в которой указан _клиент_, _работник_, _дата начала_, _общая длительность_, _список услуг_, _оплатил ли клиент услуги_ и другая информация \n* __Резерв__, __Запись-резерв__ — временная запись, бронирующая время на некоторое непродолжительное время\n* __Клиент__ содержит данные клиента одного бизнеса или сети филиалов\n\nДетальную информацию о схеме данных вы можете посмотреть в данном репозитории https://github.com/GbookingLTD/corev2-schemata/tree/master/docs.\n\nСхемы данных в формате json-schema содержатся здесь https://github.com/GbookingLTD/corev2-schemata/tree/master/schemas.\n\nКоды ошибок:\n* [полный список ошибок](https://github.com/GbookingLTD/corev2-schemata/blob/master/schemas/errors.md)\n* [ошибки авторизации](https://github.com/GbookingLTD/corev2-schemata/blob/master/schemas/common/partials/authErrorCodes.yaml)\n* [ошибки от внешних систем](https://github.com/GbookingLTD/corev2-schemata/blob/master/schemas/misErrors.md)\n* Для каждого метода указаны списки ошибок, который он может вернуть\n\nВы можете генерировать програмный код, описывающий структуру данных запросов/ответов, описанных с помощью json-schema (в yaml формате). Сгенерированные под несколько ЯП библиотек находятся [тут](https://github.com/GbookingLTD/corev2-schemata/tree/master/langs).","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"608267","team":138673,"collectionId":"036c3fc1-9f2a-aa9f-790c-f5ac7cf1dd66","publishedId":"RW83NC3i","public":true,"publicUrl":"https://documenter-api.postman.tech/view/608267/RW83NC3i","privateUrl":"https://go.postman.co/documentation/608267-036c3fc1-9f2a-aa9f-790c-f5ac7cf1dd66","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","version":"8.10.1","publishDate":"2018-08-10T11:49:02.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Showcase_Prod_6304_Demo","id":"f68d9ddb-e52a-463e-a1bd-f99ecb6d5a7d","owner":"608267","values":[{"key":"BusinessID","value":"4000000006304","enabled":true},{"key":"RPC_URL","value":"https://apiv2.gbooking.ru/rpc","enabled":true},{"key":"OAUTH_URL","value":"https://oauth2.gbooking.ru/rpc","enabled":true},{"key":"Token","value":"8e7d61be4f200e39ea29b1231006a248de108d9a","enabled":true},{"key":"UserID","value":"5b1035dcaff15607133b523f","enabled":true},{"key":"NetworkID","value":"315","enabled":true},{"key":"CRAC_SLOTS_URL","value":"https://cracslots.gbooking.ru/rpc","enabled":true},{"key":"CRAC_URL","value":"https://crac-prod3.gbooking.ru/rpc","enabled":true}],"published":true}],"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/71eac86d48ca81c6842a8bacd3d06d3de0f694cec7eb4cdf85b7692d3053a586","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"},{"label":"Showcase_Prod_6304_Demo","value":"608267-f68d9ddb-e52a-463e-a1bd-f99ecb6d5a7d"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/RW83NC3i"}