Shorten a New Link

Generate a new shortened link for yourself

POST https://sh.phyr.in/api/generate

Creates a new link

Request Body

Name

Type

Description

url*

string

URL to be shortened

publicId

string

Custom alias to be used

password

string

Custom password

Request JSON

{
    "url": "https://www.example.com",
    "publicId": "hello",
    "password": "123456"
}

{
    "success": true,
    "link": {
        "publicId": "hello",
        "analyticsId": "mICTFx"
    },
    "message": "Link created successfully"
}

Take a look at how you might call this method using curl and JS:

curl --location 'https://sh.phyr.in/api/generate' \
--header 'Content-Type: application/json' \
--data '{
    "url": "https://www.example.com",
    "publicId": "hello",
    "password": "123456"
}'

const myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");

const raw = JSON.stringify({
  "url": "https://www.example.com",
  "publicId": "hello",
  "password": "123456"
});

const requestOptions = {
  method: "POST",
  headers: myHeaders,
  body: raw,
  redirect: "follow"
};

fetch("https://sh.phyr.in/api/generate", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

const axios = require('axios');
let data = JSON.stringify({
  "url": "https://www.example.com",
  "publicId": "hello",
  "password": "123456"
});

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://sh.phyr.in/api/generate',
  headers: { 
    'Content-Type': 'application/json'
  },
  data : data
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

Possible errors

Custom alias exists: The publicId sent in the request body has been already used. Please use another publicID or keep it empty to generate a random alias.

PreviousQuick Start

Last updated 1 year ago