Тестирование API
Для работы с заявкой используется четыре основных метода. Они помогут создать заявку, подтвердить, отменить ее и получить актуальный статус
Вы можете отправлять не более 25 запросов в секунду, иначе вернется ошибка. В ответе в заголовке будет Retry-After, количество секунд ожидания и статус — код 429
CreateDemo
| POST |
|---|
| https://forma.tinkoff.ru/api/partners/v2/orders/create-demo |
Метод для создания тестовых заявок. Тестовые заявки не отправятся в банк, но вы сможете посмотреть, как работает заполнение и что увидят ваши покупатели. Для создания тестовой заявки используйте shopId, showcaseId и promocode, которые получили на этапе подготовки
Параметры заявки
- Основные
- Items
- Сontact
- Fio
| Описание | Параметр |
|---|---|
| shopId string(50), required | Идентификатор компании |
| showcaseId string(50), required | Идентификатор магазина, сайта |
| sum number, required | Общая сумма заказа |
| items Items[], required | Список товаров Описано в таблице Items |
| orderNumber string(64), optional | Номер заказа в системе партнера. Обязательный, если используются вебхуки и методы API Commit, Cancel и Info |
| promoCode string(64), optional | Идентификатор продукта: кредит или рассрочка По умолчанию default |
| webhookURL string, optional | Ссылка для отправки вебхуков Ссылка на раздел вебхуков |
| successURL string, optional | Ссылка для возврата в случае успешного завершения заявки — подписания Ссылки возврата |
| failURL string, optional | Ссылка для возврата в случае неуспешного завершения заявки — отказа банка Ссылки возврата |
| returnURL string, optional | Ссылка для возврата в случае отмены заявки Ссылки возврата |
| values object, optional | Данные покупателя для предзаполнения формы |
| values.contact Contact, optional | Данные покупателя Описано в таблице Contact |
| Описание | Параметр |
|---|---|
| name string(255), required | Название товарной позиции |
| quantity integer, required | Количество единиц товара указанной позиции |
| price number, required | Цена одной единицы товара |
| category string(255), optional | Категория товара |
| vendorCode string(64), optional | Артикул |
| Описание | Параметр |
|---|---|
| values.contact.fio FIO, optional | ФИО покупателя Описано в таблице FIO |
| values.contact.mobilePhone string, optional | Телефон покупателя. Подходит строка с номером телефона РФ в любом формате |
| values.contact.email string, optional | E-mail покупателя |
| Описание | Параметр |
|---|---|
| values.contact.fio.lastName string, optional | Фамилия покупателя |
| values.contact.fio.firstName string, optional | Имя покупателя |
| values.contact.fio.middleName string, optional | Отчество покупателя |
Вы сможете протестировать разные варианты при помощи параметра demoFlow. Также можно задать начальную стадию демонстрационной заявки. Для этого используется параметр initialStage
| Описание | Параметр |
|---|---|
| demoFlow enum, required | Тип демонстрационной заявки sms — подписание покупателем кредитных документов с помощью СМС ses — подписание покупателем документов при помощи технологии Self id appointment — подписание покупателем документов на встрече с представителем банка appointment-reject — отказ на встрече reject — отказ покупателю в рассрочке или кредите |
| initialStage enum, optional | filling — заполнение данных покупателя wait-offer — ожидание решения offers-all — предложения банков wait-offer-timeout — истек срок ожидания kvk-signing-sms — СМС подписание Т-Банка ses-documents – подписание Self ID для новых клиентов Т-Банка appointment — назначение встречи представителя Т-Банка mts-add-additional-info - заполнение дополнительных данных клиента для МТС Банка mts-documents – СМС подписание с загрузкой документов для клиентов МТС Банка mts-svyaznoy-appointment — информация о встрече МТС Банка otp-signing-sms – СМС подписание для клиентов ОТП Банка otp-documents - СМС подписание с загрузкой документов для новых клиентов МТС Банка rencredit-signing-sms - СМС подписание для клиентов банка Ренессанс kvk-issued — выдано в Т-Банке mts-issued — выдано в МТС Банке otp-issued – выдано в ОТП Банке canceled — заявка отменена rejected — по заявке отказано |
Заполните заявку любыми данными, чтобы проверить работу формы и протестировать уведомления:
- Заполните заявку и получите одобрение — в ответ на метод Info вы получите status=’approved’
- После одобрения заявку можно подписать любым СМС-кодом — в ответ на метод Info вы получите status=’signed’
- Заполните заявку и получите отказ — в ответ на метод Info вы получите status=’rejected’
Также вы можете проверить работу вебхуков. Подробнее о нотификациях.
После тестирования можно приступать к интеграции и продажам. Чтобы создавать реальные заявки, вам понадобится метод Create.
Другие методы
Чтобы применить методы Commit, Cancel и Info в тестовом режиме, используйте отличный от реальных заявок метод аутентификации. Он описан в разделе «Аутентификация» → «Тестирование».