https://github.com/vkcom/vkid-ios-sdk
https://github.com/vkcom/vkid-ios-sdk
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/vkcom/vkid-ios-sdk
- Owner: VKCOM
- License: mit
- Created: 2023-09-25T13:29:27.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-07-04T09:36:27.000Z (11 months ago)
- Last Synced: 2025-07-04T13:39:20.492Z (11 months ago)
- Language: Swift
- Size: 33.1 MB
- Stars: 13
- Watchers: 12
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .gitlab/CODEOWNERS
Awesome Lists containing this project
README
VK ID SDK — библиотека для авторизации пользователей iOS приложений с помощью аккаунта VK ID.
---
:information_source: Версии VK ID SDK 2.0.0 и выше поддерживают авторизацию по протоколу [OAuth 2.1](https://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-1-10), а также способы входа через аккаунты Одноклассников и Mail.
---
- [Предварительно](#предварительно)
- [Требования к приложению и окружению](#требования-к-приложению-и-окружению)
- [Установка](#установка)
- [Swift Package Manager](#swift-package-manager)
- [CocoaPods](#cocoapods)
- [Авторизация по кнопке OneTap](https://id.vk.com/about/business/go/docs/ru/vkid/latest/vk-id/connection/ios/onetap)
- [Шторка авторизации](https://id.vk.com/about/business/go/docs/ru/vkid/latest/vk-id/connection/ios/floating-onetap)
- [Виджет 3 в 1](https://id.vk.com/about/business/go/docs/ru/vkid/latest/vk-id/connection/elements/widget-3-1/three-in-one-ios)
- [Пользовательские сессии](https://id.vk.com/about/business/go/docs/ru/vkid/latest/vk-id/connection/ios/sessions)
- [Демонстрация](#демонстрация)
- [Документация](https://vkcom.github.io/vkid-ios-sdk/documentation/vkid/)
## Предварительно
Общий план интеграции и в целом что такое VK ID можно прочитать [здесь](https://id.vk.com/about/business/go/docs/ru/vkid/latest/vk-id/intro/plan).
Чтобы подключить VK ID SDK, сначала получите ID приложения (app_id) и защищенный ключ (client_secret). Для этого создайте приложение в [кабинете подключения VK ID](https://id.vk.com/business/go).
## Требования к приложению и окружению
* `iOS` - `12.0` и выше.
* `Swift` - `5.9` и выше.
* `Xcode` - `15.2` и выше.
|↗️ **Примечание**|
|:---|
|Если вы используете в качестве менеджера зависимостей `Swift Package Manager`|
| `Xcode` - `15.3` и выше.|
## Установка
### Swift Package Manager
Добавьте VKID как зависимость в ваш `Package.swift`:
```swift
dependencies: [
.package(url: "https://github.com/VKCOM/vkid-ios-sdk.git", .upToNextMajor(from: "2.2.0"))
]
```
### CocoaPods
Добавьте в ваш `Podfile`:
```ruby
pod 'VKID', '~> 2.2'
```
Выполните следующие команды, чтобы установить зависимости:
```shell
pod install --repo-update
```
Более подробно об установке VK ID SDK можно прочитать в статье [Как установить SDK](https://id.vk.com/about/business/go/docs/ru/vkid/latest/vk-id/connection/ios/install).
## Демонстрация
SDK поставляется с демо-приложением [VKIDDemo](VKIDDemo), где можно посмотреть работу авторизации и как кастомизируются предоставляемые визуальные компоненты. Для корректной работы демо-приложения укажите параметры `CLIENT_ID` и `CLIENT_SECRET` вашего приложения VKID в файле [Info.plist](VKIDDemo/VKIDDemo/Resources/Info.plist).