Creatio administration

Изучение документации веб-сервиса

Перед тем как приступать к настройке интеграции с REST-сервисом, необходимо изучить способы его вызова и структуру ответа, который будет получен. Эта информация, как правило, доступна в документации веб-сервиса.

Например, согласно http://fixer.io/, для вызова веб-сервиса “Fixer” можно использовать такие запросы типа GET:

https://data.fixer.io/latest — для получения последних актуальных курсов обмена валют.

https://data.fixer.io/2000-01-03 — для получения курсов валют на конкретную дату (в данном конкретном случае — на 3 января 2000 г.).

В запросах можно использовать такие параметры:

access_key – передает в запросе ваш API ключ для аутентификации на http://data.fixer.io/api/. Для получения бесплатного API ключа зарегистрируйтесь на http://fixer.io/. Обязательный параметр.

base — для указания базовой валюты, в отношении которой будут рассчитаны курсы валют в ответе от сервиса. Например, для получения курсов обмена по отношению к доллару США, используется следующий запрос: https://data.fixer.io/latest?base=USD. Если параметр “base” не был передан в запросе, будут возвращены курсы обмена валют по отношению к евро.

symbols — для указания валют, курсы обмена которых следует вернуть. Например, для получения курсов обмена доллара США, и британского фунта используется следующий запрос: https://data.fixer.io/latest?symbols=USD,GBP. Если параметр “symbols” не был передан в запросе, будут возвращены курсы обмена всех валют, поддерживаемых веб-сервисом.

Вне зависимости от метода и параметров, используемых в запросе, веб-сервис возвращает ответы в одинаковой структуре:

{"success":true,"timestamp":1521527348,"base":"EUR","date":"2018-02-22","rates":{"AUD":1.5699,"BGN":1.9558,...,"ZAR":14.384}}

Каждый ответ содержит 3 параметра:

success – указывает, был ли запрос успешным.

timestamp – объект, который содержит стандартную для UNIX отметку времени, которая указывает на время сбора данных, используемых в работе веб-сервиса.

base — указывает базовую валюту, по отношению к которой были посчитаны курсы обмена валют. Например, "base":"EUR" в ответе указывает на то, что курсы валют были рассчитаны по отношению к евро.

Date — содержит дату актуальности возвращенных курсов. Например, "date":"2018-02-22" в ответе указывает на то, что курсы валют были рассчитаны на 22 февраля 2018 года.

Rates — содержит массив вложенных параметров, каждый из которых содержит курс обмена определенной валюты по отношению к базовой валюте. Например, "rates":{"GBP":0.88343,"USD":1.2276} в ответе указывает на то, что сервисом были возвращены курсы обмена британского фунта ("GBP":0.88343) и доллара США ("USD":1.2276).

Таким образом, для интеграции с веб-сервисом Creatio необходимо настроить для отправки запросов на данный сервис и обработки ответов.

Смотрите далее

Настройка общих свойств веб-сервиса

Был ли данный материал полезен?

Как можно улучшить эту статью?