Objective:

Analyze and document the RESTful best practices implemented in each API, including their URL structure, resource naming conventions, HTTP methods usage, error handling, authentication mechanisms, and any other relevant aspects.

Twitter API:

The Twitter API can be used to programmatically retrieve and analyze Twitter data, as well as build for the conversation on Twitter. Here’s the V2 of Twitter API -

1. Authentication flow: Auth 2.0 authentication system

   

2. API endpoints:

   • Tweet lookup endpoints: must be authenticated user

     • GET https://api.twitter.com/2/tweets/:id? (single tweet)
       • tweet.fields=&expansions=&media.fields=&place.fields=&poll.fields=&user.fields= (query parameters)
     • GET https://api.twitter.com/2/tweets? (get multiple tweet)
       • ids=&tweet.fields=&expansions=&media.fields=&place.fields=&poll.fields=&user.fields= (query parameters)

   • User lookup endpoints:

     • GET https://api.twitter.com/2/users/:id (get user by id)
     • GET https://api.twitter.com/2/users/by/username/:username (get user by username)
     • GET https://api.twitter.com/2/me (authenticated user)

   • Follows endpoints:

     • GET https://api.twitter.com/2/users/:id/followers (followers of user id)

     • GET https://api.twitter.com/2/users/:id/following (Users a user ID is following)

     • POST https://api.twitter.com/2/users/:id/following (Follow a user id)

       • The authorization data will be automatically generated when we send the request

       • Pre-request script:

         // This script extracts the ID of the authenticating user, so you do not have to pass it yourself.
         if (!pm.environment.get('access_token') || !pm.request.url.path.includes(':id')) {
             return;
         }
         
         const [userId] = pm.environment.get('access_token').split('-');
         
         if (!userId) {
             return;
         }
         
         const userIdIndex = pm.request.url.path.indexOf(':id');
         pm.request.url.path[userIdIndex] = userId;
         

       • Request body:

         {
             "target_user_id": "2244994945"
         }
         

     • DELETE https://api.twitter.com/2/users/:source_user_id/following/:target_user_id (Unfollow a user id)

   • Blocks endpoints:

     • GET https://api.twitter.com/2/users/:id/blocking (Blocks lookup)
     • DELETE https://api.twitter.com/2/users/:source_user_id/blocking/:target_user_id (Unblock a user

   • Manage tweets endpoints:

     • POST https://api.twitter.com/2/tweets (Create a tweet)
     • DELETE https://api.twitter.com/2/tweets/:id (Delete a tweet)

   • Mutes endpoints:

     • POST https://api.twitter.com/2/users/:id/muting (Mute a user)
     • DELETE https://api.twitter.com/2/users/:source_user_id/muting/:target_user_id (Unmute a user)
     • GET https://api.twitter.com/2/users/:id/muting (Mutes lookup)

   • Hide replies endpoints:

     • PUT https://api.twitter.com/2/tweets/:id/hidden (Hide a reply)

       • Request body:

         {
             "hidden": true
         }
         

     • PUT https://api.twitter.com/2/tweets/:id/hidden (Unhide a reply)

       • Request body:

         {
             "hidden": false
         }
         

   • Search Tweets:

     • GET [https://api.twitter.com/2/tweets/search/recent?](https://api.twitter.com/2/tweets/search/recent?query=)
       • query=&start_time=&end_time=&since_id=&until_id=&max_results=&next_token=&tweet.fields=&expansions=&media.fields=&place.fields=&poll.fields=&user.fields= (query parameters)

   • Likes:

     • POST https://api.twitter.com/2/users/:id/likes (Like a tweet)

       • Request Body:

         {
             "tweet_id": "tweet-id-you-want-to-like"
         }
         

     • GET https://api.twitter.com/2/users/:id/liked_tweets?

       • user.fields=&expansions=&tweet.fields=&max_results=&pagination_token=
       • The authorization header will be automatically generated when we send the request

     • DELETE https://api.twitter.com/2/users/:id/likes/:tweet_id

       • Pre-request script:

         // This script extracts the ID of the authenticating user, so you do not have to pass it yourself.
         if (!pm.environment.get('access_token') || !pm.request.url.path.includes(':source_user_id')) {
             return;
         }
         
         const [userId] = pm.environment.get('access_token').split('-');
         
         if (!userId) {
             return;
         }
         
         const userIdIndex = pm.request.url.path.indexOf(':source_user_id');
         pm.request.url.path[userIdIndex] = userId;
         

       1. Error handling:

          {
              "title": "Unauthorized",
              "type": "about:blank",
              "status": 401,
              "detail": "Unauthorized"
          }
          

       2. Rate limit:

          Every day many thousands of developers make requests to the Twitter API. To help manage the sheer volume of these requests, limits are placed on the number of requests that can be made. These limits help us provide the reliable and scalable API that our developer community relies on.

          The maximum number of requests that are allowed is based on a time interval, some specified period or window of time. The most common request limit interval is fifteen minutes. If an endpoint has a rate limit of 900 requests/15-minutes, then up to 900 requests over any 15-minute interval is allowed.

     ---

     ---

   GitHub API:

   Create a new user account. The email address and username for the account must be unique.

   Base URL: https://api.github.com

   $ curl -I <https://api.github.com/users/octocat/orgs>
   
   > HTTP/2 200
   > Server: nginx
   > Date: Fri, 12 Oct 2012 23:33:14 GMT
   > Content-Type: application/json; charset=utf-8
   > ETag: "a00049ba79152d03380c34652f2cb612"
   > X-GitHub-Media-Type: github.v3
   > x-ratelimit-limit: 5000
   > x-ratelimit-remaining: 4987
   > x-ratelimit-reset: 1350085394
   > Content-Length: 5
   > Cache-Control: max-age=0, private, must-revalidate
   > X-Content-Type-Options: nosniff
   

   Endpoints available for GitHub Apps:

   **activity:**

   • GET /events
   • GET /feeds
   • GET /networks/{owner}/{repo}/events
   • GET /orgs/{org}/events
   • GET /repos/{owner}/{repo}/events
   • GET /repos/{owner}/{repo}/stargazers
   • GET /repos/{owner}/{repo}/subscribers
   • GET /users/{username}/events
   • GET /users/{username}/events/public
   • GET /users/{username}/received_events
   • GET /users/{username}/received_events/public
   • GET /users/{username}/starred
   • GET /users/{username}/subscriptions

   **actions:**

   **branches:**

   **commits:**

   dependency-graph

   emojis

   • GET /emojis

   gitignore

   • GET /gitignore/templates
   • GET /gitignore/templates/{name}

   rate-limit

   • GET /rate_limit

   search

   • GET /search/code
   • GET /search/commits
   • GET /search/issues
   • GET /search/labels
   • GET /search/repositories
   • GET /search/topics
   • GET /search/users
   1. User management and authentication:

   ---

   ---

   Stripe API:

   The Stripe API is organized around REST. Stripe API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

   Base URL: https://api.stripe.com

   HTTP status code:

Error types:

Handling error:

API endpoints: