Skip to content

Модуль внешних служб. realweb.api.service

Совместимость

realweb.api v.6

Описание

Модуль содержит api для работы со внешними службами. Модуль постоянно дополняется по мере необходимости.

Настройки для служб (доступы, настройки работы и т.п.) содержатся в модуле Настройки сайта realweb.api.config.

Dadata

Описание

Для работы функциональности необходимо зарегистрировать аккаунт для заказчика на dadata.ru и заполнить доступы в Настройках сайта realweb.api.config..

Проверка адреса по строке

Позволяет провести валидацию введенного пользователем адреса. Если информация об адресе уже запрашивалась пользователем - повторного запроса не будет происходить.

Пример практического использования
php
use \Realweb\Api\Module\Service;

Service\Model\Data\Dadata\Clean\Address::getInstance()
  ->check("Санкт-Петербург, Константиновский проспект, д.11");
Ответ
php
Array
(
    [source] => Санкт-Петербург, Константиновский проспект, д.11
    [result] => г Санкт-Петербург, пр-кт Константиновский, д 11
    [postal_code] => 197110
    [country] => Россия
    [country_iso_code] => RU
    [federal_district] => Северо-Западный
    [region_fias_id] => c2deb16a-0330-4f05-821f-1d09c93331e6
    [region_kladr_id] => 7800000000000
    [region_iso_code] => RU-SPE
    [region_with_type] => г Санкт-Петербург
    [region_type] => г
    [region_type_full] => город
    [region] => Санкт-Петербург
    [area_fias_id] =>
    [area_kladr_id] =>
    [area_with_type] =>
    [area_type] =>
    [area_type_full] =>
    [area] =>
    [city_fias_id] =>
    [city_kladr_id] =>
    [city_with_type] =>
    [city_type] =>
    [city_type_full] =>
    [city] =>
    [city_area] =>
    [city_district_fias_id] =>
    [city_district_kladr_id] =>
    [city_district_with_type] => р-н Петроградский
    [city_district_type] => р-н
    [city_district_type_full] => район
    [city_district] => Петроградский
    [settlement_fias_id] =>
    [settlement_kladr_id] =>
    [settlement_with_type] =>
    [settlement_type] =>
    [settlement_type_full] =>
    [settlement] =>
    [street_fias_id] => ae26bbfd-5e6d-4d69-8f8c-0a4964297bfe
    [street_kladr_id] => 78000000000058100
    [street_with_type] => пр-кт Константиновский
    [street_type] => пр-кт
    [street_type_full] => проспект
    [street] => Константиновский
    [house_fias_id] => 3b128ac7-e13b-4840-b96b-9d5bef93796e
    [house_kladr_id] => 7800000000005810021
    [house_cadnum] =>
    [house_type] => д
    [house_type_full] => дом
    [house] => 11
    [block_type] =>
    [block_type_full] =>
    [block] =>
    [entrance] =>
    [floor] =>
    [flat_fias_id] =>
    [flat_cadnum] =>
    [flat_type] =>
    [flat_type_full] =>
    [flat] =>
    [flat_area] =>
    [square_meter_price] =>
    [flat_price] =>
    [postal_box] =>
    [fias_id] => 3b128ac7-e13b-4840-b96b-9d5bef93796e
    [fias_code] => 78000000000000005810021
    [fias_level] => 8
    [fias_actuality_state] => 0
    [kladr_id] => 7800000000005810021
    [capital_marker] => 0
    [okato] => 40288566000
    [oktmo] => 40394000
    [tax_office] => 7813
    [tax_office_legal] => 7813
    [timezone] => UTC+3
    [geo_lat] => 59.9725542
    [geo_lon] => 30.2716095
    [beltway_hit] => IN_KAD
    [beltway_distance] =>
    [qc_geo] => 0
    [qc_complete] => 5
    [qc_house] => 2
    [qc] => 0
    [unparsed_parts] =>
    [metro] => Array
        (
            [0] => Array
                (
                    [distance] => 0.7
                    [line] => Фрунзенско-Приморская
                    [name] => Крестовский остров
                )

            [1] => Array
                (
                    [distance] => 1.7
                    [line] => Фрунзенско-Приморская
                    [name] => Чкаловская
                )

            [2] => Array
                (
                    [distance] => 2.1
                    [line] => Фрунзенско-Приморская
                    [name] => Старая деревня
                )

        )

)

Проверка телефона по введенному номеру

Позволяет провести валидацию введенного пользователем телефона. Если информация об адресе уже запрашивалась пользователем - повторного запроса не будет происходить.

Пример практического использования
php
use \Realweb\Api\Module\Service;

Service\Model\Data\Dadata\Clean\Phone::getInstance()
  ->check("8(111) 11-11-11");
Ответ

В ключе value в ответе содержится очищенный номер телефона (который годится для хранения в БД или отправки смс)

php
Array
(
    [source] => 8(111) 111-11-11
    [type] => Мобильный
    [phone] => +7 111 111-11-11
    [country_code] => 7
    [city_code] => 111
    [number] => 1111111
    [extension] =>
    [provider] => ООО "Т2 Мобайл"
    [country] => Россия
    [region] => Санкт-Петербург и Ленинградская область
    [city] =>
    [timezone] => UTC+3
    [qc_conflict] => 0
    [qc] => 0
    [value] => 71111111111
)

Проверка ИНН

Позволяет провести валидацию введенного пользователем номера ИНН. Если информация об ИНН уже запрашивалась пользователем - повторного запроса не будет происходить.

Пример практического использования
php
use \Realweb\Api\Module\Service;

Service\Model\Data\Dadata\Clean\Inn::getInstance()
  ->check("7813298266");
Ответ
php
Array
(
    [value] => ООО "РАНВЕЙ ИНТЕРНЕТ РЕШЕНИЯ"
    [unrestricted_value] => ООО "РАНВЕЙ ИНТЕРНЕТ РЕШЕНИЯ"
    [data] => Array
        (
            [kpp] => 781301001
            [capital] =>
            [invalid] =>
            [management] =>
            [founders] =>
            [managers] =>
            [predecessors] =>
            [successors] =>
            [branch_type] => MAIN
            [branch_count] => 0
            [source] =>
            [qc] =>
            [hid] => c65bd3938c009bd60b24c4af177ddf92ae33accee768152899ff87e2127e5a8b
            [type] => LEGAL
            [state] => Array
                (
                    [status] => ACTIVE
                    [code] =>
                    [actuality_date] => 1672358400000
                    [registration_date] => 1516924800000
                    [liquidation_date] =>
                )

            [opf] => Array
                (
                    [type] => 2014
                    [code] => 12300
                    [full] => Общество с ограниченной ответственностью
                    [short] => ООО
                )

            [name] => Array
                (
                    [full_with_opf] => ОБЩЕСТВО С ОГРАНИЧЕННОЙ ОТВЕТСТВЕННОСТЬЮ "РАНВЕЙ ИНТЕРНЕТ РЕШЕНИЯ"
                    [short_with_opf] => ООО "РАНВЕЙ ИНТЕРНЕТ РЕШЕНИЯ"
                    [latin] =>
                    [full] => РАНВЕЙ ИНТЕРНЕТ РЕШЕНИЯ
                    [short] => РАНВЕЙ ИНТЕРНЕТ РЕШЕНИЯ
                )

            [inn] => 7813298266
            [ogrn] => 1187847015454
            [okpo] => 24393576
            [okato] => 40288000000
            [oktmo] => 40394000000
            [okogu] => 4210014
            [okfs] => 16
            [okved] => 62.01
            [okveds] =>
            [authorities] =>
            [documents] =>
            [licenses] =>
            [finance] => Array
                (
                    [tax_system] =>
                    [income] =>
                    [expense] =>
                    [debt] =>
                    [penalty] =>
                    [year] =>
                )

            [address] => Array
                (
                    [value] => 197110, Г.Санкт-Петербург, ПР-КТ КОНСТАНТИНОВСКИЙ, Д. 11, ЛИТЕР А, ПОМ/КОМ/ОФ 1-Н/83,84/307
                    [unrestricted_value] => 197110, Г.Санкт-Петербург, ПР-КТ КОНСТАНТИНОВСКИЙ, Д. 11, ЛИТЕР А, ПОМ/КОМ/ОФ 1-Н/83,84/307
                    [invalidity] =>
                    [data] => Array
                        (
                            [postal_code] => 197110
                            [country] => Россия
                            [country_iso_code] => RU
                            [federal_district] => Северо-Западный
                            [region_fias_id] => c2deb16a-0330-4f05-821f-1d09c93331e6
                            [region_kladr_id] => 7800000000000
                            [region_iso_code] => RU-SPE
                            [region_with_type] => г Санкт-Петербург
                            [region_type] => г
                            [region_type_full] => город
                            [region] => Санкт-Петербург
                            [area_fias_id] =>
                            [area_kladr_id] =>
                            [area_with_type] =>
                            [area_type] =>
                            [area_type_full] =>
                            [area] =>
                            [city_fias_id] => c2deb16a-0330-4f05-821f-1d09c93331e6
                            [city_kladr_id] => 7800000000000
                            [city_with_type] => г Санкт-Петербург
                            [city_type] => г
                            [city_type_full] => город
                            [city] => Санкт-Петербург
                            [city_area] =>
                            [city_district_fias_id] =>
                            [city_district_kladr_id] =>
                            [city_district_with_type] => Петроградский р-н
                            [city_district_type] => р-н
                            [city_district_type_full] => район
                            [city_district] => Петроградский
                            [settlement_fias_id] =>
                            [settlement_kladr_id] =>
                            [settlement_with_type] =>
                            [settlement_type] =>
                            [settlement_type_full] =>
                            [settlement] =>
                            [street_fias_id] => ae26bbfd-5e6d-4d69-8f8c-0a4964297bfe
                            [street_kladr_id] => 78000000000058100
                            [street_with_type] => Константиновский пр-кт
                            [street_type] => пр-кт
                            [street_type_full] => проспект
                            [street] => Константиновский
                            [stead_fias_id] =>
                            [stead_cadnum] =>
                            [stead_type] =>
                            [stead_type_full] =>
                            [stead] =>
                            [house_fias_id] => 204cd298-305a-468b-bd11-7d866a174944
                            [house_kladr_id] => 7800000000005810003
                            [house_cadnum] => 78:07:0003247:1014
                            [house_type] => д
                            [house_type_full] => дом
                            [house] => 11
                            [block_type] => литера
                            [block_type_full] => литера
                            [block] => а
                            [entrance] =>
                            [floor] =>
                            [flat_fias_id] =>
                            [flat_cadnum] =>
                            [flat_type] =>
                            [flat_type_full] =>
                            [flat] =>
                            [flat_area] =>
                            [square_meter_price] =>
                            [flat_price] =>
                            [room_fias_id] =>
                            [room_cadnum] =>
                            [room_type] =>
                            [room_type_full] =>
                            [room] =>
                            [postal_box] =>
                            [fias_id] => 204cd298-305a-468b-bd11-7d866a174944
                            [fias_code] => 78000000000000005810003
                            [fias_level] => 8
                            [fias_actuality_state] => 0
                            [kladr_id] => 7800000000005810003
                            [geoname_id] => 498817
                            [capital_marker] => 0
                            [okato] => 40288566000
                            [oktmo] => 40394000
                            [tax_office] => 7813
                            [tax_office_legal] => 7813
                            [timezone] => UTC+3
                            [geo_lat] => 59.972577
                            [geo_lon] => 30.273126
                            [beltway_hit] => IN_KAD
                            [beltway_distance] =>
                            [metro] => Array
                                (
                                    [0] => Array
                                        (
                                            [name] => Крестовский остров
                                            [line] => Фрунзенско-Приморская
                                            [distance] => 0.8
                                        )

                                    [1] => Array
                                        (
                                            [name] => Чкаловская
                                            [line] => Фрунзенско-Приморская
                                            [distance] => 1.7
                                        )

                                    [2] => Array
                                        (
                                            [name] => Чёрная речка
                                            [line] => Московско-Петроградская
                                            [distance] => 2.1
                                        )

                                )

                            [divisions] =>
                            [qc_geo] => 0
                            [qc_complete] =>
                            [qc_house] =>
                            [history_values] =>
                            [unparsed_parts] =>
                            [source] => 197110, Г.Санкт-Петербург, ПР-КТ КОНСТАНТИНОВСКИЙ, Д. 11, ЛИТЕР А, ПОМ/КОМ/ОФ 1-Н/83,84/307
                            [qc] => 1
                        )

                )

            [phones] =>
            [emails] =>
            [ogrn_date] => 1516924800000
            [okved_type] => 2014
            [employee_count] =>
            [source] => 7813298266
            [inn] => 7813298266
        )

)

Проверка БИК

Позволяет провести валидацию введенного пользователем БИК банка. Если информация об БИК уже запрашивалась пользователем - повторного запроса не будет происходить.

Пример практического использования
php
use \Realweb\Api\Module\Service;

Service\Model\Data\Dadata\Clean\Bik::getInstance()
  ->check("044525974");
Ответ
php
Array
(
    [value] => АО «Тинькофф Банк»
    [unrestricted_value] => АО «Тинькофф Банк»
    [data] => Array
        (
            [opf] => Array
                (
                    [type] => BANK
                    [full] =>
                    [short] =>
                )

            [name] => Array
                (
                    [payment] => АО "Тинькофф Банк"
                    [full] =>
                    [short] => АО «Тинькофф Банк»
                )

            [bic] => 044525974
            [swift] => TICSRUMMXXX
            [inn] => 7710140679
            [kpp] => 771301001
            [okpo] =>
            [correspondent_account] => 30101810145250000974
            [treasury_accounts] =>
            [registration_number] => 2673
            [payment_city] => г Москва
            [state] => Array
                (
                    [status] => ACTIVE
                    [code] =>
                    [actuality_date] => 1709942400000
                    [registration_date] => 759715200000
                    [liquidation_date] =>
                )

            [rkc] =>
            [cbr] => Array
                (
                    [opf] => Array
                        (
                            [type] => CBR
                            [full] =>
                            [short] =>
                        )

                    [name] => Array
                        (
                            [payment] => ГУ БАНКА РОССИИ ПО ЦФО
                            [full] =>
                            [short] =>
                        )

                    [bic] => 044525000
                    [swift] =>
                    [inn] =>
                    [kpp] =>
                    [okpo] =>
                    [correspondent_account] =>
                    [treasury_accounts] =>
                    [registration_number] =>
                    [payment_city] => г Москва 35
                    [state] => Array
                        (
                            [status] => ACTIVE
                            [code] =>
                            [actuality_date] => 1709942400000
                            [registration_date] =>
                            [liquidation_date] =>
                        )

                    [rkc] =>
                    [cbr] =>
                    [address] => Array
                        (
                            [value] => 115035, г Москва 35, ул Балчуг, 2
                            [unrestricted_value] => 115035, г Москва 35, ул Балчуг, 2
                            [data] =>
                        )

                    [phones] =>
                )

            [address] => Array
                (
                    [value] => г Москва, ул Хуторская 2-я, д 38А стр 26
                    [unrestricted_value] => 127287, г Москва, Савеловский р-н, ул Хуторская 2-я, д 38А стр 26
                    [data] => Array
                        (
                            [postal_code] => 127287
                            [country] => Россия
                            [country_iso_code] => RU
                            [federal_district] => Центральный
                            [region_fias_id] => 0c5b2444-70a0-4932-980c-b4dc0d3f02b5
                            [region_kladr_id] => 7700000000000
                            [region_iso_code] => RU-MOW
                            [region_with_type] => г Москва
                            [region_type] => г
                            [region_type_full] => город
                            [region] => Москва
                            [area_fias_id] =>
                            [area_kladr_id] =>
                            [area_with_type] =>
                            [area_type] =>
                            [area_type_full] =>
                            [area] =>
                            [city_fias_id] => 0c5b2444-70a0-4932-980c-b4dc0d3f02b5
                            [city_kladr_id] => 7700000000000
                            [city_with_type] => г Москва
                            [city_type] => г
                            [city_type_full] => город
                            [city] => Москва
                            [city_area] => Северный
                            [city_district_fias_id] =>
                            [city_district_kladr_id] =>
                            [city_district_with_type] => Савеловский р-н
                            [city_district_type] => р-н
                            [city_district_type_full] => район
                            [city_district] => Савеловский
                            [settlement_fias_id] =>
                            [settlement_kladr_id] =>
                            [settlement_with_type] =>
                            [settlement_type] =>
                            [settlement_type_full] =>
                            [settlement] =>
                            [street_fias_id] => 4e8d2e47-bd86-46e0-a386-df0645711f00
                            [street_kladr_id] => 77000000000305600
                            [street_with_type] => ул Хуторская 2-я
                            [street_type] => ул
                            [street_type_full] => улица
                            [street] => Хуторская 2-я
                            [stead_fias_id] =>
                            [stead_cadnum] =>
                            [stead_type] =>
                            [stead_type_full] =>
                            [stead] =>
                            [house_fias_id] => a484f750-952d-4158-9006-caa34d6a2d7d
                            [house_kladr_id] => 7700000000030560034
                            [house_cadnum] => 77:09:0004011:1085
                            [house_type] => д
                            [house_type_full] => дом
                            [house] => 38А
                            [block_type] => стр
                            [block_type_full] => строение
                            [block] => 26
                            [entrance] =>
                            [floor] =>
                            [flat_fias_id] =>
                            [flat_cadnum] =>
                            [flat_type] =>
                            [flat_type_full] =>
                            [flat] =>
                            [flat_area] =>
                            [square_meter_price] =>
                            [flat_price] =>
                            [room_fias_id] =>
                            [room_cadnum] =>
                            [room_type] =>
                            [room_type_full] =>
                            [room] =>
                            [postal_box] =>
                            [fias_id] => a484f750-952d-4158-9006-caa34d6a2d7d
                            [fias_code] => 77000000000000030560034
                            [fias_level] => 8
                            [fias_actuality_state] => 0
                            [kladr_id] => 7700000000030560034
                            [geoname_id] => 524901
                            [capital_marker] => 0
                            [okato] => 45277586000
                            [oktmo] => 45344000
                            [tax_office] => 7713
                            [tax_office_legal] => 7713
                            [timezone] => UTC+3
                            [geo_lat] => 55.804152
                            [geo_lon] => 37.564132
                            [beltway_hit] => IN_MKAD
                            [beltway_distance] =>
                            [metro] => Array
                                (
                                    [0] => Array
                                        (
                                            [name] => Гражданская
                                            [line] => Курско-Рижский
                                            [distance] => 0.7
                                        )

                                    [1] => Array
                                        (
                                            [name] => Дмитровская
                                            [line] => Курско-Рижский
                                            [distance] => 1
                                        )

                                    [2] => Array
                                        (
                                            [name] => Дмитровская
                                            [line] => Серпуховско-Тимирязевская
                                            [distance] => 1.2
                                        )

                                )

                            [divisions] =>
                            [qc_geo] => 0
                            [qc_complete] => 5
                            [qc_house] => 2
                            [history_values] =>
                            [unparsed_parts] =>
                            [source] => 127287, г Москва, Ул. 2-я Хуторская, д.38А, стр.26
                            [qc] => 0
                        )

                )

            [phones] =>
        )

    [source] => 044525974
    [bic] => 044525974
)

Подсказка адреса

Ограничение

Платная функциональность

Позволяет "подсказать" адрес по части введенной информации.

Пример практического использования
php
use Realweb\Api\Module\Service;
$arValues = Service\Model\Data\Dadata\Suggest\Address::getInstance()
            ->run("Константиновский проспе")
Ответ
php
Array
(
    [0] => Array
        (
            [value] => г Санкт-Петербург, Константиновский пр-кт
            [unrestricted_value] => 197110, г Санкт-Петербург, Петроградский р-н, Константиновский пр-кт
            [data] => Array
                (
                    [postal_code] => 197110
                    [country] => Россия
                    [country_iso_code] => RU
                    [federal_district] => Северо-Западный
                    [region_fias_id] => c2deb16a-0330-4f05-821f-1d09c93331e6
                    [region_kladr_id] => 7800000000000
                    [region_iso_code] => RU-SPE
                    [region_with_type] => г Санкт-Петербург
                    [region_type] => г
                    [region_type_full] => город
                    [region] => Санкт-Петербург
                    [area_fias_id] =>
                    [area_kladr_id] =>
                    [area_with_type] =>
                    [area_type] =>
                    [area_type_full] =>
                    [area] =>
                    [city_fias_id] => c2deb16a-0330-4f05-821f-1d09c93331e6
                    [city_kladr_id] => 7800000000000
                    [city_with_type] => г Санкт-Петербург
                    [city_type] => г
                    [city_type_full] => город
                    [city] => Санкт-Петербург
                    [city_area] =>
                    [city_district_fias_id] =>
                    [city_district_kladr_id] =>
                    [city_district_with_type] =>
                    [city_district_type] =>
                    [city_district_type_full] =>
                    [city_district] =>
                    [settlement_fias_id] =>
                    [settlement_kladr_id] =>
                    [settlement_with_type] =>
                    [settlement_type] =>
                    [settlement_type_full] =>
                    [settlement] =>
                    [street_fias_id] => ae26bbfd-5e6d-4d69-8f8c-0a4964297bfe
                    [street_kladr_id] => 78000000000058100
                    [street_with_type] => Константиновский пр-кт
                    [street_type] => пр-кт
                    [street_type_full] => проспект
                    [street] => Константиновский
                    [stead_fias_id] =>
                    [stead_cadnum] =>
                    [stead_type] =>
                    [stead_type_full] =>
                    [stead] =>
                    [house_fias_id] =>
                    [house_kladr_id] =>
                    [house_cadnum] =>
                    [house_type] =>
                    [house_type_full] =>
                    [house] =>
                    [block_type] =>
                    [block_type_full] =>
                    [block] =>
                    [entrance] =>
                    [floor] =>
                    [flat_fias_id] =>
                    [flat_cadnum] =>
                    [flat_type] =>
                    [flat_type_full] =>
                    [flat] =>
                    [flat_area] =>
                    [square_meter_price] =>
                    [flat_price] =>
                    [room_fias_id] =>
                    [room_cadnum] =>
                    [room_type] =>
                    [room_type_full] =>
                    [room] =>
                    [postal_box] =>
                    [fias_id] => ae26bbfd-5e6d-4d69-8f8c-0a4964297bfe
                    [fias_code] =>
                    [fias_level] => 7
                    [fias_actuality_state] => 0
                    [kladr_id] => 78000000000058100
                    [geoname_id] => 498817
                    [capital_marker] => 0
                    [okato] => 40288566000
                    [oktmo] => 40394000
                    [tax_office] => 7813
                    [tax_office_legal] => 7813
                    [timezone] =>
                    [geo_lat] => 59.972591
                    [geo_lon] => 30.269946
                    [beltway_hit] =>
                    [beltway_distance] =>
                    [metro] =>
                    [divisions] =>
                    [qc_geo] => 2
                    [qc_complete] =>
                    [qc_house] =>
                    [history_values] =>
                    [unparsed_parts] =>
                    [source] =>
                    [qc] =>
                )

        )

    [1] => Array
        (
            [value] => г Санкт-Петербург, Константиновский пр-кт, д 3
            [unrestricted_value] => 197110, г Санкт-Петербург, Петроградский р-н, Константиновский пр-кт, д 3
            [data] => Array
                (
                    [postal_code] => 197110
                    [country] => Россия
                    [country_iso_code] => RU
                    [federal_district] => Северо-Западный
                    [region_fias_id] => c2deb16a-0330-4f05-821f-1d09c93331e6
                    [region_kladr_id] => 7800000000000
                    [region_iso_code] => RU-SPE
                    [region_with_type] => г Санкт-Петербург
                    [region_type] => г
                    [region_type_full] => город
                    [region] => Санкт-Петербург
                    [area_fias_id] =>
                    [area_kladr_id] =>
                    [area_with_type] =>
                    [area_type] =>
                    [area_type_full] =>
                    [area] =>
                    [city_fias_id] => c2deb16a-0330-4f05-821f-1d09c93331e6
                    [city_kladr_id] => 7800000000000
                    [city_with_type] => г Санкт-Петербург
                    [city_type] => г
                    [city_type_full] => город
                    [city] => Санкт-Петербург
                    [city_area] =>
                    [city_district_fias_id] =>
                    [city_district_kladr_id] =>
                    [city_district_with_type] =>
                    [city_district_type] =>
                    [city_district_type_full] =>
                    [city_district] =>
                    [settlement_fias_id] =>
                    [settlement_kladr_id] =>
                    [settlement_with_type] =>
                    [settlement_type] =>
                    [settlement_type_full] =>
                    [settlement] =>
                    [street_fias_id] => ae26bbfd-5e6d-4d69-8f8c-0a4964297bfe
                    [street_kladr_id] => 78000000000058100
                    [street_with_type] => Константиновский пр-кт
                    [street_type] => пр-кт
                    [street_type_full] => проспект
                    [street] => Константиновский
                    [stead_fias_id] =>
                    [stead_cadnum] =>
                    [stead_type] =>
                    [stead_type_full] =>
                    [stead] =>
                    [house_fias_id] =>
                    [house_kladr_id] =>
                    [house_cadnum] =>
                    [house_type] => д
                    [house_type_full] => дом
                    [house] => 3
                    [block_type] =>
                    [block_type_full] =>
                    [block] =>
                    [entrance] =>
                    [floor] =>
                    [flat_fias_id] =>
                    [flat_cadnum] =>
                    [flat_type] =>
                    [flat_type_full] =>
                    [flat] =>
                    [flat_area] =>
                    [square_meter_price] =>
                    [flat_price] =>
                    [room_fias_id] =>
                    [room_cadnum] =>
                    [room_type] =>
                    [room_type_full] =>
                    [room] =>
                    [postal_box] =>
                    [fias_id] => ae26bbfd-5e6d-4d69-8f8c-0a4964297bfe
                    [fias_code] =>
                    [fias_level] => 7
                    [fias_actuality_state] => 0
                    [kladr_id] => 78000000000058100
                    [geoname_id] => 498817
                    [capital_marker] => 0
                    [okato] => 40288566000
                    [oktmo] => 40394000
                    [tax_office] => 7813
                    [tax_office_legal] => 7813
                    [timezone] =>
                    [geo_lat] => 59.971817
                    [geo_lon] => 30.274456
                    [beltway_hit] =>
                    [beltway_distance] =>
                    [metro] =>
                    [divisions] =>
                    [qc_geo] => 0
                    [qc_complete] =>
                    [qc_house] =>
                    [history_values] =>
                    [unparsed_parts] =>
                    [source] =>
                    [qc] =>
                )

        )
)

Отправка сообщений (Звонков)

Описание

Состоит из различных провайдеров. Постепенно дополняется.

Все сообщения (Будь то sms или звонки) сохраняются в отдельную таблицу с результатом отправки. Интерпретация результата отправки остается на ответственности функциональности, использующего отправку сообщений.

Есть возможность отключить “боевую” отправку сообщений с сайта. Сами сообщения можно просматривать через отдельный интерфейс.

Все провайдеры обладают одинаковыми методами и не различаются по использованию.

  • setRecipient - Установить получателя (Номер телефона). Получателя можно получать из сервиса Dadata
  • setMessage - Установить сообщение
  • setCheckTime - Установить проверку на ожидание отправки следующего сообщения конкретного типа. Время ожидания редактируется через модуль Настройки сайта realweb.api.config.

Практическое использование

Для каждого провайдера создается запрос \Realweb\Api\Module\Service\Model\Sms\Request с типом сообщения (например,auth ), устанавливается получатель, сообщение и отправляется.

php
use Realweb\Api\Module\Service;

$obRequest = new Service\Model\Sms\Smsc\Request('auth');
$obRequest
        ->setRecipient(81111111111)
        ->setCheckTime(true)
        ->setMessage(4444)
        ->send();

После отправки запрос будет содержать объект ответа \Realweb\Api\Module\Service\Model\Sms\Response с коллекцией ошибок и объектом сообщения (Записью в БД \Realweb\Api\Module\Service\Model\Sms\Message\Entity, которое записывается всегда, не зависимо от ошибок провайдера)

Результат отправки записывается в поле PARAMS в виде массива

php
$arResult = $obRequest->getResponse()->getMessage()->getParams();

Каждый провайдер может проводить самостоятельные проверки (и изменения) на получателя и сообщение. В модуль встроены проверки только на “пустоту”.

Успех отправки можно проверить методом isSuccess

php
if(!$obRequest->getResponse()->isSuccess()){
  //Do something
}

Smsc.ru - отправка sms

php
use Realweb\Api\Module\Service;

$obRequest = new Service\Model\Sms\Smsc\Request('auth');
$obRequest
        ->setRecipient(81111111111)
        ->setCheckTime(true)
        ->setMessage(4444)
        ->send();

Unibell.ru - звонок

php
use Realweb\Api\Module\Service;

$obRequest = new Service\Model\Sms\Unibell\Request('auth');
$obRequest
        ->setRecipient(81111111111)
        ->setCheckTime(true)
        ->setMessage(4444)
        ->send();