iOS SDK

Crowdin SDK allows delivering new translations from the Crowdin Enterprise project to your application immediately. Using integration with Crowdin SDK, there will be no need to update the application in the App Store every time there is a new localization version.

Інтеграція забезпечує:

  • Доставки вмісту по повітрю - локалізовані файли можуть надсилатися з проекту програмі, коли це потрібно.
  • Попередній перегляд у режимі реального часу - усі переклади, зроблені в редакторі, можуть бути показані у вашій версії програми в режимі реального часу. Перегляньте переклади, які ви вже зробили, і ті, які ви зараз набираєте.
  • Скріншоти - Усі скріншоти, зроблені в програмі, разом із позначеними вихідними рядками, можуть бути автоматично надіслані вашому проекту Crowdin.

Системні вимоги

Requirements to integrate an iOS application with a project in Crowdin Enterprise:

Інструмент розробки

  • Xcode version 10.2+

Мова програмування програми

  • Swift version 4.2+

Операційна система

  • iOS version 9.0+

Дистрибуції та випуски

Configure the distribution to mirror the translated content of your project and integrate with the iOS app. Read more about Distributions.

Файл конфігурації

To configure iOS SDK integration, follow these steps:

  1. Set up Distribution in Crowdin Enterprise.
  2. Set up SDK and enable Over-The-Air Content Delivery feature using Xcode.

Налаштування розподілу

To configure distribution, follow these steps:

  1. Open your project and go to Applications > System.
  2. Find iOS SDK and click Connect. iOS Integration
  3. Define distribution. You can:
    • Add new distribution using the Create Distribution button. Select only the files translations for which you want to be shown in your application and click Create
      Create Distribution
      or
    • Select existing distribution (if any). Pay attention to the Last release time and, if needed, release distribution using the Over-The-Air Content Delivery tab. Existing Distribution
  4. Copy the distribution hash so you can use it for integration.
Note! Currently, Custom Languages, Dialects, and Language Mapping are not supported for iOS integration.

Crowdin SDK Setup

To integrate SDK with your application, you need to enable Over-The-Air Content Delivery so that the application can pull translations from the CDN vault. For this, follow step-by-step instructions located in our GitHub repository.

Advanced Features

Real-time Preview

This feature allows translators to see translations in the application in real-time. Managers and the QA team can also use it to preview translations before release.

Скріншоти

Enable this feature if you want all the screenshots made in the application to be automatically sent to your Crowdin Enterprise project with tagged strings. This way, translators will have an additional context for the source strings.

Параметри

Обов’язково для всіх функцій
your_distribution_hashUnique hash, which you can get by going to Integrations > Content Delivery. To see the distribution hash, click on the needed distribution, select Edit and copy distribution hash.
localizations Target languages of your Crowdin Enterprise project (e.g., ‘fr’, ‘el’). Формат: osx_locale.
source_languageSource language of your Crowdin Enterprise project (e.g., "en"). Формат: osx_locale.
Потрібно для додаткових функцій
client_id
client_secret
Повноваження авторизації Crowdin. Open the project and go to Applications > System > iOS SDK. In the Advanced features section, click on the needed feature, and click Get Credentials.
your_organization_domainDomain name of your Organization in Crowdin Enterprise.

Шаблони експорту файлів

You can set file export patterns and check existing ones using File Settings. The following placeholders are supported for iOS integration:

Ім'я Опис
%language% Language name (e.g., Ukrainian)
%locale% Locale (e.g., uk-UA)
%locale_with_underscore% Locale (e.g., uk_UA)
%osx_code% Локальний стандартний ідентифікатор OS X, який використовується для імені каталогу ".lproj"
%osx_locale% OS X locale used to name translation resources (e.g., uk, zh-Hans, zh_HK)

Безпека

Функція CDN для SDK Crowdin iOS побудована з урахуванням безпеки, а це означає, що можливість мінімального доступу для кінцевого користувача є обов’язковою. Якщо ви вирішили використовувати SDK Crowdin iOS, переконайтеся, що ви надали наступну інформацію для кінцевих користувачів.

  • Ми використовуємо веб-сервіси Amazon (AWS) для нашої обчислювальної інфраструктури. AWS мають сертифікацію ISO 27001 та пройшли безліч перевірок SSAE 16. Усі переклади зберігаються на серверах AWS.
  • При використанні CDN для Crowdin iOS SDK - переклади завантажуються на Amazon CloudFront для доставки до програми та прискорення завантаження. Майте на увазі, що користувачі завантажують переклади без додаткової аутентифікації.
  • Ми використовуємо шифрування для захисту ваших даних під час передачі.
  • Ми не зберігаємо будь-яку особисту інформацію (PII) кінцевого користувача, але ви можете розробити власний варіант відмови в програмі, щоб користувачі мали повний контроль.
  • Функції автоматичних знімків екрана та попереднього перегляду використовуються командами розробників та перекладачами. Those features should not be compiled to the production version of your app. Therefore, they should not affect end-users privacy in any way.

Q&A

Q: What might cause the occasional delay in getting the latest translations in the app?
A: CDN caches all the translations in release for up to 15 minutes. When new translations are released in Crowdin Enterprise, CDN may still return them with a delay.

Ця стаття була корисною?