0
Fork 0
mirror of https://github.com/logto-io/logto.git synced 2025-02-17 22:04:19 -05:00

docs(apple-connector): readme (en-US) (#1329)

* docs(apple-connector): readme (en-US)

* docs: add TOC title
This commit is contained in:
Gao Sun 2022-07-01 22:24:18 +08:00 committed by GitHub
parent f6977157a6
commit f84bc6eedd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 83 additions and 7 deletions

View file

@ -1,2 +1,78 @@
### Apple Social Connector README
placeholder
### Apple connector
The official Logto connector for Apple social sign-in.
Apple 社交登录 Logto 官方连接器 [中文文档](#)
**Table of contents**
- [Get started](#get-started)
- [Enable Sign in with Apple for your app](#enable-sign-in-with-apple-for-your-app)
- [Create an identifier](#create-an-identifier)
- [Enable Sign in with Apple for your identifier](#enable-sign-in-with-apple-for-your-identifier)
- [Compose the connector JSON](#compose-the-connector-json)
- [Test Apple connector](#test-apple-connector)
## Get started
If you don't know the concept of the connector or haven't added this connector to your Sign-in experience yet, please see [Logto tutorial](https://docs.logto.io/docs/tutorials/get-started/enable-social-sign-in).
> **Note**
>
> Apple sign-in is required for AppStore if you have other social sign-in methods in your app.
> Having Apple sign-in on Android devices is great if you also provide an Android app.
You need to enroll [Apple Developer Program](https://developer.apple.com/programs/) before continuing.
### Enable Sign in with Apple for your app
> ⚠️ **Caution**
>
> Even if you want to implement Sign in with Apple on a web app only, you still need to have an existing app that embraces the AppStore ecosystem (i.e., a valid App ID).
You can do it via Xcode -> Project settings -> Signing & Capabilities, or visit [Certificates, Identifiers & Profiles](https://developer.apple.com/account/resources/identifiers/list/bundleId).
![Enable Sign in with Apple](/packages/connector-apple/docs/enable-sign-in-with-apple-in-xcode.png)
See the "Enable an App ID" section in [Apple official docs](https://developer.apple.com/documentation/sign_in_with_apple/configuring_your_environment_for_sign_in_with_apple) for more info.
### Create an identifier
1. Visit [Certificates, Identifiers & Profiles](https://developer.apple.com/account/resources/identifiers/list/serviceId), then click the "+" button next to "Identifier".
2. In the "Register a new identifier" page, choose "Services IDs" and click "Continue".
3. Fill out "Description" and "Identifier" (E.g., `Logto Test` and `io.logto.test`), then click "Continue".
4. Double-check the info and click "Register".
### Enable Sign in with Apple for your identifier
Click the identifier you just created. Check "Sign in with Apple" on the details page and click "Configure".
![Enable Sign in with Apple](/packages/connector-apple/docs/enable-sign-in-with-apple.png)
In the opening modal, select the App ID you just enabled.
Enter the domain of your Logto instance without protocol and port, e.g., `your.logto.domain`; then enter the "Return URL" (i.e., Redirect URI), which is the Logto URL with `/callback/apple-universal`, e.g., `https://your.logto.domain/callback/apple-universal`.
![domain-and-url](/packages/connector-apple/docs/domain-and-url.png)
Click "Next" then "Done" to close the modal. Click "Continue" on the top-right corner, then click "Save" to save your configuration.
> ⚠️ **Caution**
>
> Apple does NOT allow HTTP protocol and `localhost` domain.
>
> If you want to test locally, you need to edit `/etc/hosts` file to map localhost to a custom domain and set up a local HTTPS environment. [mkcert](https://github.com/FiloSottile/mkcert) can help you for setting up local HTTPS.
## Compose the connector JSON
You need to use the identifier that fills in the [Create an identifier](#create-an-identifier) section to compose the JSON:
```json
{
"clientId": "io.logto.test"
}
```
## Test Apple connector
That's it. The Apple connector should be available in both web and native apps. Don't forget to [Enable connector in sign-in experience](https://docs.logto.io/docs/tutorials/get-started/enable-social-sign-in#enable-connector-in-sign-in-experience).

Binary file not shown.

After

Width:  |  Height:  |  Size: 48 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

View file

@ -2,7 +2,7 @@
The official Logto connector for WeChat social sign-in in native apps (iOS and Android).
微信原生应用社交登录官方 Logto 连接器iOS 和 Android[中文文档](#微信原生连接器)
微信原生应用社交登录 Logto 官方连接器iOS 和 Android[中文文档](#微信原生连接器)
**Table of contents**
@ -18,7 +18,7 @@ The official Logto connector for WeChat social sign-in in native apps (iOS and A
- [Enable WeChat native sign-in in your app](#enable-wechat-native-sign-in-in-your-app)
- [iOS](#ios)
- [Android](#android)
- [Test WeChat native connector](#test-wechat-native-connector)
- [Test WeChat native connector](#test-wechat-native-connector)
- [微信原生连接器](#微信原生连接器)
- [开始上手](#开始上手)
- [在微信开放平台中创建一个移动应用](#在微信开放平台中创建一个移动应用)
@ -31,7 +31,7 @@ The official Logto connector for WeChat social sign-in in native apps (iOS and A
- [在你的应用中启用微信原生登录](#在你的应用中启用微信原生登录)
- [iOS](#ios-1)
- [Android](#android-1)
- [测试微信原生连接器](#测试微信原生连接器)
- [测试微信原生连接器](#测试微信原生连接器)
## Get started
@ -273,7 +273,7 @@ Add the following lines to your `AndroidManifest.xml`:
</manifest>
```
### Test WeChat native connector
## Test WeChat native connector
That's it. Don't forget to [Enable connector in sign-in experience](https://docs.logto.io/docs/tutorials/get-started/enable-social-sign-in#enable-connector-in-sign-in-experience).
@ -523,7 +523,7 @@ src/main/kotlin/com/sample/app/wxapi/WXEntryActivity.kt
</manifest>
```
### 测试微信原生连接器
## 测试微信原生连接器
大功告成。别忘了 [在登录体验中启用社交登录](https://docs.logto.io/zh-cn/docs/tutorials/get-started/enable-social-sign-in/#%E5%9C%A8%E7%99%BB%E5%BD%95%E4%BD%93%E9%AA%8C%E4%B8%AD%E5%90%AF%E7%94%A8%E8%BF%9E%E6%8E%A5%E5%99%A8)。