Для перегляду параметрів API перейдіть за посиланням:
http://api.spending.gov.ua/api/swagger-ui.html
У випадаючому списку оберіть версію 2.0:
При роботі з API. Version 2.0 до трансакцій використовується формат дати РРРР-ММ-ДД (як для запиту, так і для відповіді) ISO 8601
Список методів API:
Повертає дату останнього завантаження даних до БД API
REQUEST URL: http://api.spending.gov.ua/api/v2/api/transactions/lastload
Method: GET
Content type: application/json
Перевірка доступності API
API REQUEST
URL: http://api.spending.gov.ua/api/v2/api/transactions/ping
Method: GET
Content type: application/json
Повертає ТОП-100 трансакцій по регіону
API REQUEST
URL: http://api.spending.gov.ua/api/v2/api/transactions/top100
Method: GET
Response Content type:
application/json (для відповіді в форматі json)
application/octet-stream (для відповіді в форматі csv)
Request params:
Повертає дані по транзакціях
API REQUEST
URL: http://api.spending.gov.ua/api/v2/api/transactions/
Method: GET
Response Content type:
application/json (для відповіді в форматі json)
application/octet-stream (для відповіді в форматі csv)
Request params:
API RESPONSE
{
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":"00034022", "recipt_edrpous":"33882399", "startdate" : "2017-09-12", "regions":"" | { "id": 62528229, "doc_number": "286/2/2380", "doc_date": "2017-09-08", "doc_v_date": "2017-09-12", "trans_date": "2017-09-12", "amount": "6291.78", "payer_edrpou": "00034022", "payer_name": "МОУ", "payer_account": "35226207018611", "payer_mfo": "820172", "payer_bank": "Держказначейська служба України,м.Київ", "recipt_edrpou": "33882399", "recipt_name": "ТОВ \"Укрпродакорд ОР\"", "recipt_account": "26002300401559", "recipt_mfo": "322669", "recipt_bank": "ФГОЛОВНЕ УПРАВЛІННЯ ПО АТОЩАД М.КИЇВ", "payment_details": "2101020,2230;опл.за харч.платн.хвор.у 04-06.17р;акт5/А3122-25/А3122-07.09.17,договірN286/2/17/1 вiд 28.03.17,д/у №1-6 від 31.08.2017;Без ПДВ", "doc_add_attr": null, "region_id": 28 } |
200 OK — успішний запит. Якщо клієнтом були запитані будь-які дані, то вони знаходяться в заголовку і / або тексті повідомлення. З'явився в HTTP / 1.0.
201 Created — в результаті успішного виконання запиту був створений новий ресурс. Детальніше тут.
401 Unauthorized — для доступу до запитуваного ресурсу потрібно аутентифікація. Детальніше тут.
403 Forbidden — сервер зрозумів запит, але він відмовляється його виконувати через обмеження в доступі для клієнта до зазначеного ресурсу. Детальніше тут.
404 Not Found —найпоширеніша помилка при користуванні Інтернетом, основна причина - помилка в написанні адреси Web-сторінки. Детальніше тут.