Skip to content

Commit

Permalink
Merge pull request #110 from loshan20011/main
Browse files Browse the repository at this point in the history
Update README file with Setup guide and Quick start
  • Loading branch information
NipunaRanasinghe authored Jun 28, 2024
2 parents b9572ac + 9025c1e commit 85bae8d
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 24 deletions.
32 changes: 8 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,23 +42,23 @@ To use the Twitter connector, you must have access to the Twitter API through a

### Step 4: Setup OAuth 2.0 Flow

Before proceeding with the Quickstart, ensure you have obtained the Refresh Token and Access Token using the following steps:
Before proceeding with the Quickstart, ensure you have obtained the Access Token using the following steps:

1. Create an authorization URL using the following format:

```
https://twitter.com/i/oauth2/authorize?response_type=code&client_id=<your_client_id>&redirect_uri=<your_redirect_uri>&scope=tweet.read%20tweet.write%20users.read%20follows.read%20offline.access&state=state&code_challenge=<your_code_challenge>&code_challenge_method=plain
https://twitter.com/i/oauth2/authorize?response_type=code&client_id=<your_client_id>&redirect_uri=<your_redirect_uri>&scope=tweet.read%20tweet.write%20users.read%20follows.read&state=state&code_challenge=<your_code_challenge>&code_challenge_method=plain
```
Replace `<your_client_id>`, `<your_redirect_uri>`, and `<your_code_challenge>` with your specific values. Make sure to include the necessary scopes depending on your use case.
Example:
```
https://twitter.com/i/oauth2/authorize?response_type=code&client_id=asdasASDas21Y0OGR4bnUxSzA4c0k6MTpjaQ&redirect_uri=http://example&scope=tweet.read%20tweet.write%20users.read%20follows.read%20offline.access&state=state&code_challenge=D601XXCSK57UineGq62gUnsoasdas1GfKUY8QWhOF9hiN_k&code_challenge_method=plain
https://twitter.com/i/oauth2/authorize?response_type=code&client_id=asdasASDas21Y0OGR4bnUxSzA4c0k6MTpjaQ&redirect_uri=http://example&scope=tweet.read%20tweet.write%20users.read%20follows.read&state=state&code_challenge=D601XXCSK57UineGq62gUnsoasdas1GfKUY8QWhOF9hiN_k&code_challenge_method=plain
```
**Note:** By default, the access token you create through the OAuth 2.0 Flow will only stay valid for two hours unless you’ve used the `offline.access` scope.
**Note:** By default, the access token you create through the OAuth 2.0 Flow, as used here, will only remain valid for two hours. There is an alternative way that does not invalidate the access token after 2 hours. To do this, refer to [Obtain access token under offline.access](https://developer.x.com/en/docs/authentication/oauth-2-0/user-access-token).
2. Copy and paste the generated URL into your browser. This will redirect you to the Twitter authorization page.
Expand Down Expand Up @@ -86,19 +86,18 @@ Before proceeding with the Quickstart, ensure you have obtained the Refresh Toke
--data-urlencode "code_verifier=<your_code_verifier>"
```
This command will return the refresh token and access token necessary for API calls.
This command will return the access token necessary for API calls.
```json
{
"token_type":"bearer",
"expires_in":7200,
"access_token":"VWdEaEQ2eEdGdmVSbUJQV1U5LUdWREZuYndVT1JaNDdIZGMzblNjRGtvb3dGOjE3MTkzNzYwOTQ1MDQ6MTowOmF0OjE",
"scope":"follows.read offline.access tweet.write users.read tweet.read",
"refresh_token":"N21DQUNmRTg5eDJmNFlEYnd4SEhFNFJJSjQ0NGFnSlBNZVJsMG4wX1FpeF9XOjE3MTkzNzYwOTQ1MDQ6MToxOnJ0OjE"
"access_token":"VWdEaEQ2eEdGdmVSbUJQV1U5LUdWREZuYndVT1JaNDddsdsfdsfdsxcvIZGMzblNjRGtvb3dGOjE3MTkzNzYwOTQ1MDQ6MTowOmF0Oj",
"scope":"tweet.write users.read follows.read tweet.read"
}
```
5. Store the refresh token and access token securely for use in your application.
5. Store the access token securely for use in your application.
**Note**: We recommend using the OAuth 2.0 Authorization Code with PKCE method as used here, but there is another way using OAuth 2.0 App Only. If you want, you can go through this link: [OAuth 2.0 App Only](https://developer.twitter.com/en/docs/authentication/oauth-2-0/application-only). Refer to this document to check which operations in Twitter API v2 are done using which method: [API reference](https://developer.twitter.com/en/docs/authentication/guides/v2-authentication-mapping).
Expand Down Expand Up @@ -148,21 +147,6 @@ bal run
```


**Note**: Obtained Access tokens are not explicitly expired. Follow the below step to invalidate access token

### Invalidate access token

```bash
curl --location --request POST "https://api.twitter.com/2/oauth2/revoke" ^
--header "Content-Type: application/x-www-form-urlencoded" ^
--data-urlencode "token=<your_access_token>" ^
--data-urlencode "client_id=<your_client_Id>" ^
--data-urlencode "token_type_hint=access_token"
```

Replace `<your_client_id>`, and `<your_access_token>` with your specific values.


## Building from the source

### Prerequisites
Expand Down
Binary file modified docs/setup/resources/get-keys.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 85bae8d

Please sign in to comment.