{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"0c651474-bb80-4e2f-a760-93e1756d0205","name":"ОСАГО","description":"## Введение\n\n<p>Данная документация описавает процесс использования данного аггрегационного API для интеграции со страховыми компаниями для продажи договоров ЕОСАГО.</p>\n\n```\nAPI: https://osago.ads-soft.ru/\nKEY: SECRET_KEY_DEMO\n\n ```\n\n<p>В описании методов конструкция {{api}} обозначает адрес API, например запись {{api}}/models/?key=SECRET_KEY_DEMO означает https://osago.ads-soft.ru/models/?key=SECRET_KEY_DEMO</p>\n\n<p>API помогает верно заполнять входящие параметры. Например может вернуться ошибка примерно такого вида: Необходимо заполнить параметр policy/owner/name, это значит что не передан параметр policy[owner][name]. В любом случае, API будет сообщать что и как надо заполнить, если необходимо.</p>\n\n## Порядок вызова методов API\n\n<p>Методы АПИ должны вызываться в строгом порядке. Описание параметров методов находится ниже по документации в соответствующих разделах. В данном разделе показывается логический алгоритм использования методов API.<br>Форматом ответа каждого метода является json-структура:<br><br></p>\n\n```\n{\n    result: true/false,\n    message: ...,\n    data: ...\n}\n\n ```\n\nВ случае успешного запроса result = true, необходимо обрабатывать параметры data и message в зависимости от метода. В случае ошибки запроса result = false, описание ошибки находится в параметре message.\n\n<p>Порядок выполнения запросов следующий:</p>\n\n##### 1\\. Отправка заявки на расчеты\n\n```\n{{api}}/calculate/?fullInformation=true\n\n ```\n\n<p>В данный метод передаются первичные данные по договору для расчета страховых премий.<br>В ответ на этот запрос вернутся идентификаторы расчетов, по которым можно получить результаты расчетов.<br>Это сделано для того, что уже в визуальном интерфейсе можно было независимо опрашивать результаты каждого конкретного расчета,<br>а не ждать когда все расчеты будут завершены. Если передан параметр <code>fullInformation</code>, то помимо идентифкаторов расчета будут доступны и названия компаний, по которым производится расчет.</p>\n\n##### 2\\. Получение результатов расчета\n\n```\n{{api}}/calculate/:id/\n\n ```\n\n<p>Получение результатов расчета по его идентификатору <code>:id</code>.</p>\n\n##### 3\\. Создание проекта договора\n\n```\n{{api}}/create/\n\n ```\n\n<p>После того как определено с каким расчетом и какой страховой компании необходимо создать договор, необходимо создать проект договора с нужным набором данных и соответствующим идентификаторм расчета. В ответе на этот метод вернется идентификатор созданного проекта договора.</p>\n\n##### 4\\. Проверка статуса проекта договора\n\n```\n{{api}}/policy/:policyId/status/\n{{api}}/policy/:policyId/info/\n\n ```\n\n<p>После того, как проект договора создан, необходимо дождаться статуса \"Согласован\".<br>Для этого надо опрашивать данный метод с идентификатором договора <code>:policyId</code>.</p>\n\n  \nПока нет данного статуста, оплатить и перевести проект договора в договор невозможно.\n\n  \nСогласование осуществляется либо в автоматическом режиме, если РСА посчитает все введные данные корректными, это может занять 1-3 минуты.\n\n  \nЛибо в ручном режиме, в таком случае в ответе вернется список документов, которые надо загрузить к проекту договора. Далее сотрудник СК в ручном режиме согласует проект договора. **В любом случае, для продолжения дальнейших действий статус у проекта договора должен быть \"Согласован\"****.**\n\n**Метод** **`/status/`** **вернет информацию по статусу в РСА. Если РСА затребует загрузку документов, это так же будет в ответе на данный метод.**\n\n**Метод** **`/info/`** **вернет информацию по проекту договора. Именно в нем будет поле Status, в котором должно быть значение \"Согласован\".**\n\n**Для \"бумажного\" договора ОСАГО рекомендуем использовать запрос** **`{{api}}/policy/:policyId/info/`****, в нем присутствует необходимая информация по статусам**\n\n##### **4.1. Дозагрузка документов в РСА для согласования**\n\n```\n<strong >{{api}}/policy/:policyId/upload/</b>\n\n ```\n\n**При необходимости загрузки документов, таких как: паспорт, права и т.д. необходимо воспользоваться данным методом. После загрузки, статус проект договора сменится на \"Проверка документов\", и далее сотрудник страховой компании в ручную должен согласовать проект договора.**\n\n> **ВАЖНО: После загрузки всех необходимых файлов необходимо вызвать метод** **`/policy/:policyId/register/`** **чтобы проект договора направить на согласование с загруженными документами!** \n  \n\n##### **5\\. Выбор способа оплаты**\n\n```\n<strong >{{api}}/policy/:policyId/acquiring/</b>\n\n ```\n\n**Как только проект договора переведен в статус \"Согласован\", то для оплаты договора необходимо сначала выбрать способ оплаты предоставляемый той или иной страховой компаней. Данный метод по параметру** **`:policyId`** **(идентификатору проекта договора) вернет такой список с названием и кодом платежного иструмента.**\n\n##### **6\\. Получение ссылки на оплату**\n\n```\n<strong >{{api}}/policy/:policyId/acquiring/:code/</b>\n\n ```\n\n**Данный метод вернет ссылку на оплату, куда нужно перенаправить пользователя. В метод передаются возвратные ссылки при успешной или неуспешной оплаты, идентификатор договора** **`:policyId`****, код выбранного платежного инструмента** **`:code`** **из предыдущего метода. Если эквайринг компании позволяет переопределять ссылки, то можно вернуть пользователя в свою систему. Если нет, то процесс продолжится и завершится на сайте страховой компании.**\n\n**Для теста параметр** **`:code`** **можно использовать со значением** **`alfa`****. Данные по тестовой карте:**\n\n```\n<strong >Карта: 4111 1111 1111 1111</b>\n<strong >Срок действия: 12/2024</b>\n<strong >Владелец: Тест</b>\n<strong >CVC: 123</b>\n<strong >Код подтверждения: 12345678</b>\n\n ```\n\n**При успешной оплате проект договора станет договором и статус сменится на \"Оформлен\". То есть можно опрашивать метод** **`{{api}}/policy/:policyId/info/`****, при успешной оплате параметр** **`StatusPay`** **станет в значение \"Оплачен\", а когда договор будет зарегистрирован в РСА, то параметр** **`Status`** **встанет в значение \"Оформлен\". После этого можно вызывать методы получения PDF документов, при необходимости.**\n\n**После успешной оплаты параметр** **`StatusPay`** **меняется на \"Оплачен\" почти моментально, а параметр** **`Status`** **меняется в течение 1-2 минут.**\n\n> **ВАЖНО: После успешной оплаты обязательно надо вызвать метод** **`{{api}}/policy/:policyId/info/`****, чтобы зафиксировать факт оплаты!** \n  \n\n##### **7\\. Получение PDF документов договора**\n\n```\n<strong >{{api}}/policy/:policyId/pdf/</b>\n<strong >{{api}}/policy/:policyId/application/</b>\n\n ```\n\n**Когда договор оформлен, то есть возможность получить в PDF формате сам договор и заявление.**\n\n---\n\n**Так выглядит логический процесс оформления полиса ЕОСАГО. Далее будет более подробное описание каждого метода, учавствующего в данном процессе.**","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"4072694","team":100950,"collectionId":"0c651474-bb80-4e2f-a760-93e1756d0205","publishedId":"RVu8hT2a","public":true,"publicUrl":"https://documenter-api.postman.tech/view/4072694/RVu8hT2a","privateUrl":"https://go.postman.co/documentation/4072694-0c651474-bb80-4e2f-a760-93e1756d0205","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","version":"8.10.1","publishDate":"2018-04-13T09:35:28.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/bfbf748869256f98ca3dea3c3756b02a874ab6d5cd4dbfd5ca5ace2276ee7af4","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/RVu8hT2a"}