Валюти: методи API Bimp
Методи API Bimp для ресурсу «Валюти» (/org2/currency/…): 2 методи. Базова адреса: https://app.bimpsoft.com. Усі запити, крім входу, передають токен компанії в заголовку access-token — див. Початок роботи з API.
| Метод | Що робить |
|---|---|
POST /org2/currency/api-readList | A request to view a list of currencies |
POST /org2/currency/api-read | A request to obtain detailed information for a particular currency |
api-readList
POST /org2/currency/api-readList
A request to view a list of currencies
Тіло запиту (JSON)
| Поле | Тип | Обов’язкове | Опис |
|---|---|---|---|
pagination | object | так | |
pagination.offset | number | так | Begin from {offset} elements |
pagination.count | number | так | Limit of paginated elemets |
Відповідь: поле data
| Поле | Тип | Опис |
|---|---|---|
[].uuid | string | |
[].name | string | |
[].code | string |
curl -X POST 'https://app.bimpsoft.com/org2/currency/api-readList' \
-H 'access-token: <токен компанії>' \
-H 'Content-Type: application/json' \
-d '{"pagination":{"offset":0,"count":10}}'
api-read
POST /org2/currency/api-read
A request to obtain detailed information for a particular currency
Тіло запиту (JSON)
| Поле | Тип | Обов’язкове | Опис |
|---|---|---|---|
uuid | string (uuid) | так | A unique uuid key for a currency |
Відповідь: поле data
| Поле | Тип | Опис |
|---|---|---|
uuid | string | |
name | string | |
code | string |
curl -X POST 'https://app.bimpsoft.com/org2/currency/api-read' \
-H 'access-token: <токен компанії>' \
-H 'Content-Type: application/json' \
-d '{"uuid":"00000000-0000-0000-0000-000000000000"}'
Інтерактивна документація з можливістю надіслати тестовий запит: https://app.bimpsoft.com/docs. Специфікація OpenAPI оновлюється разом із Bimp; ця сторінка згенерована з неї автоматично.