Version 1.0.0

Last Updated: April 8, 2025

Responsible: Luis Amaya

Generation

Introduction

Generator is the component of Links responsible for shortening URLs, and creating QR codes

Authentication Methods

This service authenticates through the authentication service provided by Masiv platform, it can authenticate through the Authorization header with a Bearer or Basic Token.

Headers:
Authorization: Bearer/Basic <Authentication Token>

Formats

Endpoints

The following endpoints perform the function of shortening URLs.

Shorter has the function of shortening 1 or more URLs and returning the Link or multiple short Links. QR has the function of shortening 1 URL and returning in Base 64 a QR Code that represents the shortened URL.

Both endpoints are POST type methods whose body and response are in JSON format.

POST Shorter

POST QR

Response Codes

List of possible HTTP/S response codes that the system can generate

Code Name Description
🟢200 Success Successful request
🟠400 Bad Request Erroneous request due to an error in any of the request parameters
🟠401 Unauthorized Unauthorized client / Invalid credentials
🟠403 Forbidden Incorrect token / User does not have permission to access resources.
🟠404 Not Found Non-existent resource or route
🔴500 Internal Server Error Internal resource error
🔴503 Service Unavailable Resource / Service not available

Redirection

Introduction

The redirection API allows the redirection from the short URL used by the client to the long URL in the browser, in basic context, it is responsible for redirecting the client's request to the destination URL.

Authentication Methods

Given the nature of the component, there is no authorization whatsoever, as anyone with a valid URL should be able to access it without needing to authenticate.

Formats

Endpoint

Endpoint responsible for redirecting a segment to the long URL associated with it. The segment must be in alphanumeric format.

GET /{Segment}