Aviasales Travel iOS SDK

README in English

Описание

Aviasales Travel iOS SDK — набор библиотек, позволяющий добавить поиск авиабилетов и отелей в ваше приложение. Когда пользователь покупает билет или бронирует отель, вы получаете вознаграждение. SDK используется при разработке официальных приложений Aviasales и Hotellook. SDK включает в себя:

• две библиотеки для интеграции с поисковой системой поиска авиабилетов и отелей;
• шаблонный проект с пользовательским интерфейсом. Вы можете использовать шаблонный проект для создания своего собственного поискового приложения. Чтобы отслеживать выплаты, посетите нашу партнерскую сеть — Travelpayouts.com. Узнайте подробнее о доходах в Travelpayouts FAQ.

Использование шаблонного проекта

📲 Установка

1. Скачайте себе последний release (не beta) шаблонного проекта отсюда: https://github.com/KosyanMedia/Aviasales-iOS-SDK/releases.
2. Скачайте зависимости, выполнив команду pod install --repo-update в каталоге с шаблонным проектом. После этого для работы с проектом используйте файл AviasalesSDKTemplate.xcworkspace.
3. Подставьте правильные значения партнерского токена и маркера в файле default_config.plist в константы partner_marker и api_token.
4. Если у вас еще нет партнерского маркера и токена, получите их в Travelpayouts.
5. В конфиге default_config.plist дополнительно можно включать и выключать вкладки поиска билетов / отелей, добавлять описание приложения, email для обратной связи и ссылку на приложение в App Store, которые будут отображаться в разделе «About», плюс локализованные значения для внешних ссылок, подставлять параметры поиска, которые будут выставлены по умолчанию при первом запуске приложения.

📱 Поддержка версий iOS

Поддерживаются версии, начиная с iOS 9.0

🖼 Иконка приложения

Не забудьте заменить иконку приложения (по умолчанию, в шаблоне используются иконки, залитые белым цветом). Для этого в папке AviasalesSDKTemplate/Resources/App.xcassets/AppIcon.appiconset достаточно заменить картинки (20.png, 29.png, 40.png и т.д.) на свои с аналогичными именами.

✈️🏨 Выбор вкладок

Если вы хотите убрать вкладку поиска билетов или поиска отелей, поменяйте значения flights_enabled или hotels_enabled на NO в конфиге проекта. Вкладку настроек убрать таким способом нельзя.

🔧 Предустановка фильтров

Если вы хотите ограничить выдачу билетов по одной или нескольким авиакомпаниям, добавьте IATA этих компаний в конфиг по ключу available_airlines как элементы массива. Также можно ограничить выбор города поиска отелей. Для этого в конфиге следует перевести параметр selectable в значение NO и заполнить текст, который будет использоваться в качестве заголовка на форме (параметр headers по ключам локализации). И обязательно нужно прописать id и название города поиска.

🇺🇸🇷🇺 Локализация

Локализации для текстов можно настроить через установку NSLSKey в разделе "Attributes Inspector" в xib-файлах.

✍🏻 Поддержка RTL

Шаблонное приложение адаптировано под RTL языки. Раздел отели при включении RTL языка в настройках устройства становится недоступен.

🔧🌻 Настройка цветов

Выбрать цветовую схему можно в файле ColorSchemeManager.swift. Достаточно прописать в переменной current одно из значений BlackColorScheme() / BlueColorScheme() / PurpleColorScheme(). Или установить значение CustomColorScheme() и настроить схему по своему усмотрению в файле CustomColorScheme.swift. Внешний вид и цвета элементов тоже можно настроить в xib-файлах. Смотрите доступные для изменения поля в разделе "Attributes Inspector". В качестве ключей для цветов можно использовать любые значения из JRColorScheme.h. Вот список основных полей с пояснениями:

Название	Описание
mainColor	Основной цвет приложения
actionColor	Цвет выделения основных действий
formTintColor	Цвет иконок и кнопок на формах поиска
formBackgroundColor	Цвет фона в формах поиска
formTextColor	Цвет текстов в формах поиска

Если вам нужно больше настроек, например, цвета индикатора загрузки фотографий отелей или цвета элементов в фильтрах, воспользуйтесь настройками в файле JRColorScheme.m.

🤑 Настройка рекламы Appodeal

Для того чтобы вы могли получать дополнительную прибыль с рекламы, мы интегрировали в приложение рекламный SDK Appodeal. Для его настройки задайте параметр appodeal_key в конфиге default_config.plist (получите ключ API, зарегистрировавшись в Appodeal). По умолчанию, реклама будет отображаться на экранах ожидания поиска билетов и отелей.

⭐️ Обратная связь и оценка приложения

Задайте значения параметрам feedback_email и itunes_link в файле default_config.plist чтобы активировать пункты меню "Написать нам письмо" и "Оценить приложение".

🏭 Использование Fabric/Crashlytics

В шаблонное приложение встроена библиотека Fabric/Crashlytics, которая позволяет отслеживать крэши в приложении, а также рассылать тестовые сборки. Чтобы активировать эти функции, вам необходимо зарегистрироваться и получить API Key и Build Secret на сайте https://fabric.io. Далее необходимо:

1. Прописать соответствующие значения в файле fabric.sh в корневой папке
2. Прописать Fabric > APIKey в файле AviasalesSDKTemplate-Info.plist