Short URL

Short URL Creator API allows you to easily create short URLs for use in SMS messages, surveys, links to specific pages, etc. You simply pass the target URL as a parameter, and the API returns the short URL. Fast, secure, and easy to use, the API makes it a great option for developers integrating short URLs into their systems.

Response Properties

  • Name
    short_url
    Type
    string
    Description

    The short URL target.

  • Name
    target_url
    Type
    string
    Description

    The short URL generated for your url target.


POST/v1/url/shorten

Create Short URL

This API allows you to create a short URL for any purpose. It is accessible via GET requests. These methods can be used on any device or platform that supports them. Short urls can be used for various purposes, such as sharing webpages, making payments, etc.

Required attributes

  • Name
    target
    Type
    string
    Description

    The target URL to which the shortened URL will redirect.

Optional attributes

  • Name
    campaign
    Type
    string
    Description

    Assign this short url to campaign

  • Name
    tags
    Type
    string
    Description

    Tag this short url to improve your statistics results

Request

POST
/v1/url/shorten
  curl -X POST "https://api.hoppah.io/v1/url/shorten"  
      -H "x-api-key: {ApiKey}" 
      -H "Content-Type: application/json" -d '{
      "target": "https://www.google.com",
      "campaign": "product1",
      "tags": "winter24, website"
  }'

Response

{
  "data": {
      "short_url": "https://lnkly.me/x9w9wk",
      "target_url": "https://www.google.com"
  },
  "ststus": true
}

Was this page helpful?