404, пока не объявлен доступ к боевой среде. В песочнице плата не взимается.
Это краткое руководство проведёт вас от приложения в песочнице к счетам, балансам и транзакциям Didit Test Bank с помощью готовых запросов, которые можно скопировать и вставить.
Каждый ответ ниже сокращён до важных полей.
Храните API-ключ на сервере: он никогда не попадает в браузер или приложение.
Шаг 1: создайте API-ключ с разрешением Bank data
Bank data не входит в полный доступ. Ключ с полным доступом, в том числе основной секрет приложения, отклоняется при каждом вызове Bank data с ошибкой403 bank_data_access_denied.
- В Business Console откройте ваше приложение в песочнице и перейдите в раздел API keys.
- Создайте ключ с настраиваемым доступом и добавьте Bank data: Read для операций чтения, Write для вызовов, которые создают, изменяют или удаляют что-либо.
- Скопируйте ключ и экспортируйте его:
Шаг 2: создайте ссылку
Ссылка представляет собой один проход по экранам, на которых пользователь подключает банк. Создайте постоянную ссылку для тестового банка:country содержит трёхбуквенный код страны банка пользователя и является необязательным.
Передавайте его, когда знаете страну: тогда пользователь увидит только банки этой страны. Если его не передать, пользователь выбирает среди банков всех стран, с которыми вы можете работать.
Для одноразового доступа передайте "access": "one_time" (это значение по умолчанию).
id ссылки, связав его с пользователем.
url и client_token возвращаются один раз, при создании ссылки.
Шаг 3: откройте ссылку и подключите Didit Test Bank
Откройтеurl в браузере или отправьте его пользователю по электронной почте или в чат.
Пользователь видит экран согласия, выбирает Didit Test Bank, входит в систему как один из тестовых клиентов и выбирает счета, к которым предоставляет доступ.
На странице песочницы перечислены тестовые клиенты и то, что каждый из них предоставляет.
Чтобы вернуть пользователя на ваш сайт после завершения, см. раздел Возврат на ваш сайт.
Если redirect_url не задан, пользователь завершает процесс на странице результата Didit, а результат вы узнаёте из webhook или из запроса на чтение данных.
Step 4: получите webhook-уведомления и подтвердите результат
Подпишите адрес назначения на событияbank.* в консоли так же, как для любого другого webhook.
Когда конечный пользователь завершает процесс, приходит bank.link.completed с link_id и connection_id. Затем, после того как первая синхронизация сохранит счета, приходит bank.connection.created.
Никогда не доверяйте идентификатору ссылки, который передаёт браузер.
Запросите данные ссылки самостоятельно:
status принимает значение completed или одно из конечных значений: cancelled, expired, failed. Ссылка со статусом failed содержит error.code. У ссылки со статусом cancelled в ответе указано error: null.
Шаг 5: чтение счетов, балансов и транзакций
next_page_token.
См. Счета, балансы и транзакции.
Шаг 6: отслеживание ленты изменений
Лента изменений возвращает только то, что изменилось с момента вашего последнего чтения. Первое чтение без курсора возвращает полный снимок: каждую транзакцию, имеющуюся у подключения, с пометкойadded и reset: true.
Первая страница может содержать has_more: true с next_page_token, но без next_cursor.
Пока has_more равно true, продолжайте чтение с помощью page_token. Сохраните next_cursor последней страницы (той, где has_more: false), чтобы использовать его при следующем чтении:
reset: true означает, что ответ является полным снимком: замените им свою копию, а не добавляйте к ней.
bank.data.updated сообщает, когда синхронизация сохранила новые данные.
Шаг 7: синхронизация сейчас
Постоянное подключение синхронизируется автоматически. Чтобы считать данные банка прямо сейчас, запросите синхронизацию:sync.live_syncs_left_today и sync.budgets в подключении показывают, сколько их осталось и когда счётчик сбрасывается. Вызов сверх лимита возвращает 429 refresh_limit_reached и время сброса.
См. Обновление данных банка по запросу.
Шаг 8: остановка доступа и удаление
Прекращение доступа и удаление выполняются разными вызовами.id, status, status_reason, created_at и erasure.
Подробнее см. в разделе Данные, согласие и удаление.
Следующие шаги
- Подключения: разовый и постоянный доступ, согласие и продление.
- Банковские webhook
- Цены
- Справочник API