Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Функция currencyCurrency/export function (http://<DOMAIN>/api/currency/export/)

ПараметрыParameters:

  • token - ключ авторизации полученный через функцию authauthorisation key obtained through the auth function
  • iso - ISO код валюты или ISO коды валют (передавать в массиве) для выгрузки - не обязательный параметр
  • id - выгрузка валют по идентификатору/идентификаторам (передавать массивом в таком случае) - не обязательный параметр
  • enabledOnly - выгрузить только включенные во фронтенде валюты (по умолчанию этот параметр включен). Если этот параметр указан - то параметр iso будет игнорирован

Ответ:

  • status - статус выполнения функции

  • OK - курсы валют были успешно выгружены

  • EMPTY - запрос не дал результатов
  • code of currency or ISO codes of currencies (pass in array) for unloading - not obligatory parameter
  • id - unload currencies by identifier(s) (pass in array in this case) - optional parameter
  • enabledOnly - unload only currencies enabled in the frontend (by default this parameter is enabled). If this parameter is specified - the iso parameter will be ignored

Response:

  • status - status of the function execution
    • OK - currency rates were successfully unloaded
    • EMPTY - the query failed
  • response.currency[] -
  • скисок валют
  • currency discount
    • response.currency[i].id -
  • идентификатор валюты в системе
    • currency identifier in the system
    • response.currency[i].iso -
  • международный ISO код валюты
    • international ISO code of currency
    • response.currency[i].title -
  • читаемое название валюты
    • readable currency name
    • response.currency[i].exchangeRates[] -
  • курсы валют
    • currency rates
      • response.currency[i].exchangeRates[n].relatedId -
  • идентификатор валюты в отношении которой указан обменный курс
      • currency identifier for which the exchange rate is specified
      • response.currency[i].exchangeRates[n].relatedIso -
  • международный ISO код валюты в отношении которой указан обменный курс
      • international ISO code of the currency against which the exchange rate is specified
      • response.currency[i].exchangeRates[n].currentExchangeAmount -
  • значение суммы исходной валюты
      • value of the amount of the source currency (response.currency[i].id)
  • относительно которой считается курс
      • against which the exchange rate is calculated
      • response.currency[i].exchangeRates[n].relatedExchangeAmount -
  • значение суммы текущей валюты
      • value of the current currency amount (response.currency[i].exchangeRates[n].relatedId)
  • относительно которой считается курс
      • against which the rate is calculated
      • response.currency[i].exchangeRates[n].exchangeCourse -
  • обменный курс валюты относительно 1-й денежной единицы исходной валюты и текущей
      • exchange rate of the currency relative to 1 currency unit of the original currency and the current currency (response.currency[i].exchangeRates[n].currentExchangeAmount / response.currency[i].exchangeRates[n].relatedExchangeAmount)


Пример запроса на адрес Request example to (http://<DOMAIN>/api/currency/export/):


Code Block
{
    "token" : "<ВАШ ТОКЕН>",
    "iso" : ["UAH", "USD"]
}


Пример ответа на запросResponse example:

Code Block
{
    "status": "OK",
    "response": {
        "currency": [
            {
                "id": 1,
                "iso": "UAH",
                "title": "Гривна",
                "exchangeRates": [
                    {
                        "relatedId": 2,
                        "relatedIso": "EUR",
                        "currentExchangeAmount": 26,
                        "relatedExchangeAmount": 1,
                        "exchangeCourse": 26
                    },
                    {
                        "relatedId": 3,
                        "relatedIso": "USD",
                        "currentExchangeAmount": 22.5,
                        "relatedExchangeAmount": 1,
                        "exchangeCourse": 22.5
                    }
                ]
            },
            {
                "id": 2,
                "iso": "EUR",
                "title": "Евро",
                "exchangeRates": [
                    {
                        "relatedId": 1,
                        "relatedIso": "UAH",
                        "currentExchangeAmount": 1,
                        "relatedExchangeAmount": 26,
                        "exchangeCourse": 0.038461538461538
                    },
                    {
                        "relatedId": 3,
                        "relatedIso": "USD",
                        "currentExchangeAmount": 0.87,
                        "relatedExchangeAmount": 1,
                        "exchangeCourse": 0.87
                    }
                ]
            }
        ]
    }
}

...