Этап получение API-key к магазину
Для работы с API понадобиться API-key. Для получения API-key открываем магазин, нажав на него в списке.
Переключаемся на вкладку Настройки.
Нажимаем на Генерировать API-key.
Придумываем название для API-key и вводим его в открывшейся форме. Нажимаем кнопку “Генерировать”.
Новый ключ появиться в таблице “API-key”.
Копируем ключ, для дальнейшего использования, нажав на иконку в открывшемся окне либо в списке всех API-key.
Скопируйте ключ, для дальнейшего использования, нажав на иконку
Либо воспользуйтесь Qr-кодом, нажав на иконку
Скопируйте ключ, для дальнейшего использования, нажав на иконку
Либо воспользуйтесь Qr-кодом, нажав на иконку
Работа с заказами
Описание процесса создания и оплаты заказа через API
Создать checkout
Когда пользователь делает покупку в вашем магазине, то для того, чтобы оплатить через Overgold вам необходимо сперва создать checkout.
Checkout создается путем вызова метода
/market/shops/{shop_id}/checkouts POST
Подробнее см. - https://doc.overgold.app/ovg-pay/#tag/Checkouts/paths/~1ovg-pay~1shops~1%7Bshop_id%7D~1checkouts/post
Перевести пользователя на страницу оплаты
Когда checkout создан, пользователя необходимо перевести на страницу в кабинете Overgold.
Для этого необходимо сделать редирект по следующему
URL - https://pay.overgold.app/{checkoutID}
, где {checkoutID} - это уникальный идентификатор checkout, который вы получили на Шаге 1.
Оплата пользователем checkout в кабинете Overgold
Пользователь попадает на страницу оплаты заказа. Если пользователь в данный момент не авторизован в кабинете, то сперва он попадет на страницу логина, а затем перейдет к оплате.
После того, как пользователь оплатит заказ, система Overgold вызовет callback_url , который был указан в checkout для уведомления вашего магазина о том, что пользователь завершил все необходимые действия и теперь можно проверить статус платежа.
Пользователь же будет переведен по redirect_url, который был указан в checkout.
