Формат запитів до API
API ключі, API URL робочих серверів та детальну консультацію можна отримати у службі підтримки Smart-Era.
Всі запити до API шлюзу надсилаються за допомогою протоколу REST у форматі JSON методами POST, GET та PATCH.
Заголовки
Для підтвердження запиту користувача API необхідно передавати заголовок api_token_key у форматі API Key в кожному запиті.
Наприклад: api_token_key: api_token.
Формат відповідей
Відповіді від API можуть містити об'єкти з даними, так і можуть не містити об'єктів зовсім. Якщо під час виконання запиту виникла помилка, у відповіді від API ви отримаєте код помилки.
Структура об'єктів у відповіді залежить від методу API і описана в документації кожного методу. Поля об'єктів у відповіді завжди обов'язкові.
Приклади запиту та відповіді
Запити до API можуть містити як єдиний об'єкт або декілька об'єктів, так і можуть не містити об'єктів зовсім.
Приклад запиту
{
"document_name": "Test TEST Test",
"fields": [
{
"name": "DOCDATE",
"description": "Дата документа",
"data_type": 5,
"group": "MAIN",
"path": "0.0.DOCDATE",
"value": "02.06.2023"
},
{
"name": "DOCSUM",
"description": "Сума по документа",
"data_type": 2,
"group": "MAIN",
"path": "0.0.DOCSUM",
"value": 0
}
]
}
Приклад успішної відповіді
200 OK
{
"Edrpou": "12312312",
"Dept": null,
"LongName": "Some long name",
"ShortName": "Some short name",
"Indtaxnum": "12312312312312",
"DateFrom": "16.12.2020",
"UpdateDate": "26.04.2021 16:15:36",
"FullAddr": "Богдана Хмельницького, буд. 11-А, м. Київ, 01111, Україна",
"Tel": "0444444444"
}
Приклад неуспішної відповіді
204 No Content