Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

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

Параметры:

  • token - ключ авторизации полученный через функцию auth

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

Ответ:

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

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

    • EMPTY - запрос не дал результатов

  • response.currency[] - скисок валют

    • response.currency[i].id - идентификатор валюты в системе

    • response.currency[i].iso - международный ISO код валюты
    • response.currency[i].title - читаемое название валюты
    • response.currency[i].exchangeRates[] - курсы валют
      • response.currency[i].exchangeRates[n].relatedId - идентификатор валюты в отношении которой указан обменный курс
      • response.currency[i].exchangeRates[n].relatedIso - международный ISO код валюты в отношении которой указан обменный курс
      • response.currency[i].exchangeRates[n].currentExchangeAmount - значение суммы исходной валюты (response.currency[i].id) относительно которой считается курс
      • response.currency[i].exchangeRates[n].relatedExchangeAmount - значение суммы текущей валюты (response.currency[i].exchangeRates[n].relatedId) относительно которой считается курс
      • response.currency[i].exchangeRates[n].exchangeCourse - обменный курс валюты относительно 1-й денежной единицы исходной валюты и текущей (response.currency[i].exchangeRates[n].currentExchangeAmount / response.currency[i].exchangeRates[n].relatedExchangeAmount)


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


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


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

{
    "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
                    }
                ]
            }
        ]
    }
}
  • No labels