Documentation
    Amazon Web Services
    Microsoft Azure
    RapidAPI
    APILayer
Last Update: 2024-03-01

aws3.link URL Shortener


Table of Content


Subscribe on AWS Marketplace
Code samples
API endpoint: Shorten
API endpoint: Remove
API endpoint: Track
Custom Domain Integration
Troubleshooting

Subscribe on AWS Marketplace


Navigate to our product listing on the AWS Marketplace. Select the "View purchase options" button to proceed.

On the following page, click the "Subscribe" button to initiate the subscription process.

After subscribing, you will need to set up your account on our platform. Do this by clicking the "Set up your account" link provided.

You will be directed to the registration page. Here, fill in your account details in the provided fields. Once you have entered all necessary information, click the 'Subscribe' button to proceed.

Upon successful registration, your unique API key will be displayed. It is crucial to store this key in a secure location for future use.

Code samples


The following code samples creates a short URL with a random key. The link gets expired after 24 hours. Replace <YourApiKey> with the actual API Key you received during the sign-up process:

var client = new RestClient("https://api.aws3.link/shorten");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("x-api-key", "<YourApiKey>");
request.AddHeader("Content-Type", "application/json");
var body = @"{" + "\n" +
@"    ""longUrl"": ""https://www.silverlining.cloud/docs/aws/aws3""," + "\n" +
@"    ""expireHours"": 24" + "\n" +
@"}";
request.AddParameter("application/json", body,  ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
API endpoint: Shorten


URL endpoint: https://api.aws3.link/shorten


Method: POST


"header": {
  "x-api-key": STRING,
  "Content-Type": "application/json"
}


"body": {
  "longUrl": STRING,
  "customKey": STRING,
  "expireHours": NUMBER,
  "keyLength": STRING,
  "customDomain": STRING
}



Required

"longUrl": The destination URL you want to redirect. Protocol (http, https) needs to be included.

 
Optional

"customKey": Define a custom key ("aws3.link/customKey"). Passing no customKey will generate a random string as key.

 "expireHours": Define after how many hours the shortened URL will expire. Needs to be between 1 and 8760 (= 1 year). Default is 0, which means non-expiring link.

"keyLength": This parameter allows you to define the length of the randomly generated key. It can be set to any value between 4 and 8. If not specified, the default length is set to 6 characters.

"customDomain": Pass the domain name you want to shorten your URL. Please see paragraph 'Custom domain integration' below before using it.
Public facing custom domain: an.si - Try it out by passing 'an.si' to customDomain parameter.

Response:


"body": {
  "shortUrl": STRING,
  "metadata": {
    "longUrl": STRING,
    "domain": STRING,
    "key": STRING,
    "expiration": DATE,
  }
}
API endpoint: Remove


URL endpoint: https://api.aws3.link/remove


Method: POST


"header": {
  "x-api-key": STRING,
  "Content-Type": "application/json"
}


"body": {
  "key": STRING,
  "customDomain": STRING
}


Required
 
"key": The key of the short URL you want to delete. 'myKey' for aws3.link/myKey e.g.

Optional

"customDomain": If you are using a custom domain, specify to which domain the provided key belongs to.


Response:


"body": {
  "message": "Provided key has been removed",
  "metadata": {
    "longUrl": STRING,
    "domain": STRING,
    "key": STRING
  }
}

API endpoint: Track

URL endpoint: https://api.aws3.link/track


Method: POST


"header": {
  "x-api-key": STRING,
  "Content-Type": "application/json"
}


"body": {
  "key": STRING,
  "customDomain": STRING
}

Required 
"key": The key of the short URL you want to track. 'myKey' for aws3.link/myKey e.g.

Optional

"customDomain": If you are using a custom domain, specify to which domain the provided key belongs to.

Response:


"body": {
  "totalHits": NUMBER,
  "hits": [{
    "date": DATE,
    "time": TIME,
    "ip": STRING,
    "method": STRING,
    "resource": STRING,
    "referrer": STRING,
    "user": {
      "platform": {
        "name": STRING,
        "version": STRING,
      },
      "os": {
        "name": STRING,
      },
      "bot": BOOLEAN,
      "flavour": {
        "name": STRING,
        "version": STRING,
      },
      "browser": {
        "name": STRING,
        "version": STRING
      }
    },
    "rawUserAgent": STRING,
    "timeTaken": FLOAT
  }],
  "metadata": {
    "longUrl": STRING,
    "domain": STRING,
    "key": STRING
  }
}

"totalHits": Number of successfully registered clicks

"hits: List of actual click. Consists of: date and time that URL was clicked, IP address click, referring URL and detailed information of the users device.

"metadata": Long URL, (custom) domain and key of the request

Custom Domain Integration


Leverage the full potential of our URL shortener service by utilizing your own domain, offering you a personalized and branded shortening experience. To begin this seamless integration, please ensure you follow these steps:

Subscription Requirement: Ensure you are enrolled in our "Pay-Per-Use" subscription plan, a prerequisite for accessing the custom domain functionality.

Custom Domain Acquisition: Visit the AWS Marketplace and subscribe to our "Custom Domain Add-On". This crucial step enables the custom domain feature for your account.

DNS Configuration: Upon successful subscription, we will contact you via email with the necessary DNS records. Adding these records to your domain's DNS settings is essential for linking your domain with our URL shortener and validating an SSL certificate to support HTTPS traffic.

API Endpoint Usage: After configuring your domain, you can make API calls with the customDomain parameter to our /shorten, /remove, and /tracking endpoints. This allows for smooth operations using your own domain.

Important Note: The responsibility of purchasing and maintaining the domain rests solely with the customer. Ensure your domain is active and properly configured to prevent any service disruptions.

By following these steps, you can enhance your URL shortening service with a custom domain, providing a more branded and professional appearance for your short links. Should you encounter any issues or have questions during the setup process, our support team is here to assist you.

Troubleshooting

"message": "Invalid Input: The request contains incorrectly formatted parameters"

This error message means that the body parameters you have passed are malformed. Please follow the instructions given in the endpoint descriptions. Common issues include forgetting to add a comma (',') after every parameter line or missing a parenthesis somewhere.

"message": "Endpoint request timed out"

You receive this error message when the code execution exceeds the maximum timeout (usually 29 seconds).

Batch Import of Shortened URLs

If you are currently using another URL shortening service and wish to import your existing shortened URLs to our platform, we offer support for batch imports. Please contact us at support@silverlining.cloud, and one of our engineers will assist you throughout the process.