rettiwt-api 2.4.0 → 2.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +14 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -64,11 +64,22 @@ Although the above process initializes a new project, that is, in fact, not nece
|
|
|
64
64
|
|
|
65
65
|
- It's also possible to use this package without using a Twitter account, by omitting the 'apiKey' parameter in the config object. However, in this case, 'guest' authentication is used.
|
|
66
66
|
|
|
67
|
-
## The
|
|
67
|
+
## The API_KEY
|
|
68
68
|
|
|
69
|
-
The
|
|
69
|
+
The API_KEY generated by logging in is what allows Rettiwt-API to authenticate as a logged in user while interacting with the Twitter API ('user' authentication). As such it is a very sensitive information and therefore, must be stored securely. The following points must be kept in mind while using the API_KEY for 'user' authentication:
|
|
70
70
|
|
|
71
|
-
The
|
|
71
|
+
- The API_KEY is generated by logging into Twitter using the email, username and password and encoding the returned cookies as a base64 string. This encoded string is the API_KEY.
|
|
72
|
+
- The API_KEY provides the same level of authorization as any standard Twitter account, nothing more, nothing less.
|
|
73
|
+
- Since generation of API_KEY is equivalent to logging in to Twitter, repeated generation attempts might trigger Twitter's anti-bot measures, the same way repeated login attempts do.
|
|
74
|
+
- The API_KEY expires after one year from the day it was generated.
|
|
75
|
+
- Therefore, it is recommended to generate the API_KEY only once, then use it every time it is needed.
|
|
76
|
+
- Do not generate an API_KEY if it has not expired yet!
|
|
77
|
+
|
|
78
|
+
## The Rettiwt class
|
|
79
|
+
|
|
80
|
+
The Rettiwt class is entry point for accessing the Twitter API.
|
|
81
|
+
|
|
82
|
+
The Rettiwt class has two members:
|
|
72
83
|
|
|
73
84
|
- 'tweet' member, for accessing resources related to tweets
|
|
74
85
|
- 'user' member, for accessing resources related to users
|