Для перегляду параметрів API перейдіть за посиланням:
http://api.spending.gov.ua/api/swagger-ui.html
Список методів API:
Повертає дату останнього завантаження даних до БД API
REQUEST URL: http://api.spending.gov.ua/api/rest/1.0/lastload
Method: GET
Content type: application/json
Перевірка доступності API
API REQUEST
URL: http://api.spending.gov.ua/api/rest/1.0/ping
Method: GET
Content type: application/json
Request params:
Повертає дані по транзакціях
Повертає масив даних транзакцій по використанню коштів з єдиного казначейського кореспондентського рахунку
API REQUEST
URL: http://api.spending.gov.ua/api/rest/1.0/transactions
Method: POST
Content type: application/json
Request params:
TransactionsRequest
{
payers_edrpous (Array[string], optional): Код платника,
recipt_edrpous (Array[string], optional): Код отримувача,
startdate (string, optional): Дата з, (Формат ДД-ММ-РРРР)
enddate (string, optional): Дата по, (Формат ДД-ММ-РРРР)
regions (Array[integer], optional): Регіон
}
API RESPONSE
TransactionResponse
{
response (TransactionsInnerResponse, optional)
}
TransactionsInnerResponse
{
errors (Array[Error], optional),
request (TransactionsRequest, optional),
transactions (Array[Transaction], optional)
}
Error
{
error (string, optional)
}
Transaction
{
id (integer, optional): Унікальний ідентифікатор,
doc_number (string, optional): Номер розрахункового документа,
doc_date (string, optional): Дата складання, (Формат ДД-ММ-РРРР)
doc_v_date (string, optional): Дата валютування, (Формат ДД-ММ-РРРР)
trans_date (string, optional): Дата оплати, (Формат ДД-ММ-РРРР)
amount (string, optional): Сума,
payer_edrpou (string, optional): Код платника,
payer_name (string, optional): Найменування платника,
payer_account (string, optional): Рахунок платника,
payer_mfo (string, optional): Код банку платника,
payer_bank (string, optional): Найменування банку платника,
recipt_edrpou (string, optional): Код отримувача,
recipt_name (string, optional): Найменування отримувача,
recipt_account (string, optional): Рахунок отримувача,
recipt_bank (string, optional): Найменування банку отримувача,
recipt_mfo (string, optional): Код банку отримувача,
payment_details (string, optional): Призначення платежу,
doc_add_attr (string, optional): Додатковий реквізит,
region_id (integer, optional): Регіон
}
ПРИКЛАД
API REQUEST (Request params): | API RESPONSE |
---|---|
{ "payers_edrpous":["39883094","09334702"], "startdate" : "30-09-2015", "regions":[1,2,3,5] | { "response": { "errors": [], "transactions": [ { "id": 5081729, "doc_number": "81 ", "doc_date": "29-10-2015", "doc_v_date": "30-10-2015", "trans_date": "30-10-2015", "amount": "674.98", "payer_edrpou": "39883094", "payer_name": "Слов'янська ОДПІ ГУ ДФС у Донецьк. об", "payer_account": "35215059091200", "payer_mfo": "834016", "payer_bank": "ГУ ДКСУ У ДОНЕЦЬКІЙ ОБЛАСТІ", "recipt_edrpou": "39883094", "recipt_name": "Слов'янська ОДПI ГУ ДФС у Дон обл", "recipt_account": "37195201010522", "recipt_mfo": "834016", "recipt_bank": "ГУ ДКСУ У ДОНЕЦЬКІЙ ОБЛАСТІ", "payment_details": "*;101;39883094;КПКВК 3301010 КЕКВ 2111-674,98 ЄДРПОУ 38660601Утримання єдиного внеску 2% iз з/ти за жовтень 2015р., пер.повнiстю,термiн сплати 30.10.2015р.;;;", "doc_add_attr": null, "region_id": 5 }, {... }, ... |
200 OK — успішний запит. Якщо клієнтом були запитані будь-які дані, то вони знаходяться в заголовку і / або тексті повідомлення. З'явився в HTTP / 1.0.
201 Created — в результаті успішного виконання запиту був створений новий ресурс. Детальніше тут.
401 Unauthorized — для доступу до запитуваного ресурсу потрібно аутентифікація. Детальніше тут.
403 Forbidden — сервер зрозумів запит, але він відмовляється його виконувати через обмеження в доступі для клієнта до зазначеного ресурсу. Детальніше тут.
404 Not Found —найпоширеніша помилка при користуванні Інтернетом, основна причина - помилка в написанні адреси Web-сторінки. Детальніше тут.