Requirements

Functional Requirements:

• Create a short URL for a given long URL.
• Return the long URL associated with a given short URL.

Non-Functional Requirements:

• List the key non-functional requirements (eg low latency, scalability, reliability, etc.)...
• Service should not be down anytime (Uptime 99.9%)
• The Service should not take longer than 1 sec.
• The Service should support multiple requests in any time.

API Design

Define the APIs expected from the system. This is your chance to analyze and define the read and write paths so that you can come up with the high-level design...

I need the next API endpoint and validations:

• Associate request to a user (ip will not work, i need something to bind a user to a account)
• For the Shortener API i will need the next endpoint:
  • https://shortener.api.tinyurl.com/api/v1/short-url
    • Request Payload: JSON {url: "...."}
    • Answer Payload: JSON {originalUrl: "", shortUrl: ""}

High-Level Design

Describe the overall system architecture. Identify the main components needed to solve the problem end-to-end. Use the diagramming tool to create a block diagram.

As a High-Level Design i define the next system architecture:

2 APIs:

• AUTH API: API thats handle all de authentication logic, principally login (as a internal login/register or a extenal api usage of google, hotmail, etc), this will also allows OAuth2 use of the shortener API. Endpoints:
  • https://auth.api.tinyurl.com/api/v1/register
  • https://auth.api.tinyurl.com/api/v1/login (return OAuth Bearer token)
  • https://auth.api.tinyurl.com/api/v1/validate (endpoint to validate if a token is valid)
• Shortener API: API
  • Principal Business Logic API, this will in easy terms contains all the business logic of the shortening service. This will reuse the auth api logic to allow user to identify them.
  • https://shortener.api.tinyurl.com/api/v1/short-url
  • If the requests comes with no auth bearer token, then return 401. Else check if its valid against the api and if its valid then allow to process the sended url (validate payload)

Also you can check the high level diagram.

Also, thinking about the multiple request, i will available a bulk endpoint to the user doesnt need to make multiple requests for multiples urls, only one with longer data.

Detailed Component Design

Deep dive into 2-3 key components. Explain how they work, how they scale, discuss tradeoffs, capacity, and any relevant algorithms or data structures.