go-monobank/README.md

47 lines
4.0 KiB
Markdown
Raw Normal View History

2024-04-15 21:38:50 +03:00
[![Go Reference](https://pkg.go.dev/badge/gitea.stuzer.link/stuzer05/go-monobank.svg)](https://pkg.go.dev/gitea.stuzer.link/stuzer05/go-monobank)
2024-05-12 12:36:47 +03:00
# Go API client for swagger
2024-04-15 21:38:50 +03:00
2024-05-12 12:36:47 +03:00
API для отримання інформації про виписки та стан особистого рахунку та рахунків ФОП. Для надання доступу потрібно пройти авторизацію у особистому кабінеті https://api.monobank.ua/ та отримати токен для персонального використання. Якщо у вас є запитання щодо роботи API, запрошуємо до ком'юніті у [Telegram-групі](https://t.me/joinchat/FiAEWhDf-QzTqM4wzEtffw). API недоступне для клієнтів до 16 років, дані за дитячими рахунками доступні з батьківського акаунту. Якщо у вас є сервіс і ви хочете централізовано приєднатися до API для надання послуг клієнтам, потрібно підключитися до [API для провайдерів послуг](/docs/corporate.html), що має більше можливостей. Якщо дані клієнтів не будуть надходити на ваші сервери або ви робите сервіс для своєї родини, використання корпоративного API необов'язкове. Розробка бібліотек або програм, які будуть використовувати клієнти особисто (дані клієнта не будуть проходити черeз вузли розробника), також не потребують використання корпоративного API. Це надасть змогу клієнтам monobank авторизуватись у вашому сервісі (наприклад, у фінансовому менеджері) для надання інформації про стан рахунку або виписки. У разі виявлення експлуатації цього API в якості корпоративного, банк залишає за собою право накласти санкції на компанію.
2024-04-10 22:18:44 +03:00
## Overview
2024-05-12 12:36:47 +03:00
This API client was generated by the [swagger-codegen](https://github.com/swagger-api/swagger-codegen) project. By using the [swagger-spec](https://github.com/swagger-api/swagger-spec) from a remote server, you can easily generate an API client.
2024-04-10 22:18:44 +03:00
- API version: v2303
- Package version: 1.0.0
2024-05-12 12:36:47 +03:00
- Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen
2024-04-10 22:18:44 +03:00
## Installation
Put the package under your project folder and add the following in import:
2024-05-12 12:36:47 +03:00
```golang
import "./swagger"
2024-04-10 22:18:44 +03:00
```
## Documentation for API Endpoints
All URIs are relative to *https://api.monobank.ua*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
2024-05-12 12:36:47 +03:00
*_Api* | [**BankCurrencyGet**](docs/_Api.md#bankcurrencyget) | **Get** /bank/currency | Отримання курсів валют
*_Api* | [**PersonalClientInfoGet**](docs/_Api.md#personalclientinfoget) | **Get** /personal/client-info | Інформація про клієнта
*_Api* | [**PersonalStatementAccountFromToGet**](docs/_Api.md#personalstatementaccountfromtoget) | **Get** /personal/statement/{account}/{from}/{to} | Виписка
*_Api* | [**PersonalWebhookPost**](docs/_Api.md#personalwebhookpost) | **Post** /personal/webhook | Встановлення WebHook
2024-04-10 22:18:44 +03:00
## Documentation For Models
- [CurrencyInfoInner](docs/CurrencyInfoInner.md)
2024-05-12 12:36:47 +03:00
- [ModelError](docs/ModelError.md)
2024-04-10 22:18:44 +03:00
- [SetWebHook](docs/SetWebHook.md)
- [StatementItemsInner](docs/StatementItemsInner.md)
- [UserInfo](docs/UserInfo.md)
2024-05-12 12:36:47 +03:00
- [UserInfoAccounts](docs/UserInfoAccounts.md)
- [UserInfoJars](docs/UserInfoJars.md)
2024-04-10 22:18:44 +03:00
## Documentation For Authorization
2024-05-12 12:36:47 +03:00
Endpoints do not require authorization.
2024-04-10 22:18:44 +03:00
## Author