This repository has been archived by the owner on Jun 30, 2023. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #138 from mironal/refresh-oauth20-helper
Refresh oauth20 helper
- Loading branch information
Showing
9 changed files
with
558 additions
and
81 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,133 @@ | ||
| # How do I authenticate? | ||
|
|
||
| There are multiple and complex ways to authenticate to Twitter. You will also need to configure your settings in the Developer Portal. | ||
|
|
||
| This document describes how to set up the Developer Portal and authenticate using TwitterAPIKit. | ||
|
|
||
| ## Type of authentication method | ||
|
|
||
| - OAuth 1.0a (3-legged OAuth flow) | ||
| - PIN based | ||
| - OAuth 2.0 Authorization Code Flow with PKCE | ||
| - OAuth 2.0 Bearer Token (app-only) | ||
|
|
||
| ## OAuth 1.0a (3-legged OAuth flow) | ||
|
|
||
| ### Preparations | ||
|
|
||
| Turn on the OAuth 1.0a switch. | ||
|
|
||
| <div style="text-align: center;"> | ||
| <img height="400" src="./imgs/AuthTypeSwitch.png" /> | ||
| </div> | ||
|
|
||
| ### Auth | ||
|
|
||
| > https://developer.twitter.com/en/docs/authentication/oauth-1-0a/obtaining-user-access-tokens | ||
| See the code in the sample project. | ||
|
|
||
| ### PIN based | ||
|
|
||
| > https://developer.twitter.com/en/docs/authentication/oauth-1-0a/pin-based-oauth | ||
| ```swift | ||
| // for CLI tool | ||
| func runOAuth() { | ||
| client.auth.postOAuthRequestToken(.init(oauthCallback: "oob")).responseObject(queue: .main) { response in | ||
| do { | ||
| let success = try response.result.get() | ||
| print("Token:", success) | ||
|
|
||
| let url = client.auth.makeOAuthAuthorizeURL(.init(oauthToken: success.oauthToken, forceLogin: true))! | ||
| print("Enter this URL into your browser and enter the PIN code that will be displayed after authentication.") | ||
| print(url) | ||
|
|
||
| let pinCode = readLine()! | ||
|
|
||
| client.auth.postOAuthAccessToken(.init(oauthToken: success.oauthToken, oauthVerifier: pinCode)) | ||
| responseObject(queue: .main) { response in | ||
| do { | ||
| let success = try response.result.get() | ||
| print("AccessToken:", success) | ||
|
|
||
| } catch let error { | ||
| print("Error") | ||
| print(error) | ||
| } | ||
| } | ||
| } catch let error { | ||
| print("Error") | ||
| print(error) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // Output of runOAuth | ||
|
|
||
| /* | ||
| Token: TwitterOAuthTokenV1(oauthToken: "your-token", oauthTokenSecret: "your-secret", oauthCallbackConfirmed: Optional(true)) | ||
| Enter this URL into your browser and enter the PIN code that will be displayed after authentication. | ||
| https://api.twitter.com/oauth/authorize?force_login=true&oauth_token=your-token | ||
| > your pin | ||
| AccessToken: TwitterOAuthAccessTokenV1(oauthToken: "", oauthTokenSecret: "", userID: Optional(""), screenName: Optional("")) | ||
| */ | ||
| ``` | ||
|
|
||
| ## OAuth 2.0 Authorization Code Flow with PKCE | ||
|
|
||
| ### Preparations | ||
|
|
||
| Turn on the OAuth 2.0 switch. | ||
|
|
||
| <div style="text-align: center;"> | ||
| <img width="600" src="./imgs/AuthTypeSwitch.png" /> | ||
| </div> | ||
|
|
||
| OAuth 2.0 Authorization Code Flow with PKCE has two authentication methods: Public Client and Confidential Client. | ||
|
|
||
| Please check which authentication method you have selected. | ||
|
|
||
| Most iOS applications are Public Client (Native App). | ||
|
|
||
| <div style="text-align: center;"> | ||
| <img width="600" src="./imgs/OAuth20Type.png" /> | ||
| </div> | ||
|
|
||
| ### Auth | ||
|
|
||
| > https://developer.twitter.com/en/docs/authentication/oauth-2-0/authorization-code | ||
| See the code in the sample project. | ||
|
|
||
| ## OAuth 2.0 Bearer Token (app-only) | ||
|
|
||
| > > https://developer.twitter.com/en/docs/authentication/oauth-2-0/application-only | ||
| ```swift | ||
|
|
||
| var client: TwitterAPIClient! | ||
|
|
||
| func runAuth() { | ||
| client = TwitterAPIClient( | ||
| .basic(apiKey: "your consumer key", apiSecretKey: "your consumer secret") | ||
| ) | ||
|
|
||
| client.auth.postOAuth2BearerToken(.init()).responseObject(queue: .main) { response in | ||
| do { | ||
| let success = try response.result.get() | ||
| print("Token:", success) | ||
| } catch let error { | ||
| print("Error") | ||
| print(error) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func useBearerToken() { | ||
| let client = TwitterAPIClient(.bearer("<token>")) | ||
| client.v1.getUserTimeline(.init(target: .screenName("twitterapi"))).responseData { response in | ||
| print(response.prettyString) | ||
| } | ||
| } | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.