Shortener

An API Key is required for this service. See Shared Responses for common error responses.

Shorten A URL

POST https://yiff.rocks/create

If Read Only is enabled, a 503 Service Unavailable will be returned.

Query Parameters

Name

Type

Description

editable

Boolean

If the shortened url should be editable (you will get a code to edit with)

Request Body

Name

Type

Description

code

String

The code to use, random if not specified.

credit

String

The name to credit, Unknown if not specified.

url*

String

The URL to shorten.

// Max: 50
{
  "success": false,
  "error": "Provided code is too long.",
  "code": 1070
}

// RegEx: /^(?:(?:(?:https?|ftp):)?\/\/)(?:\S+(?::\S*)?@)?(?:(?!(?:10|127)(?:\.\d{1,3}){3})(?!(?:169\.254|192\.168)(?:\.\d{1,3}){2})(?!172\.(?:1[6-9]|2\d|3[0-1])(?:\.\d{1,3}){2})(?:[1-9]\d?|1\d\d|2[01]\d|22[0-3])(?:\.(?:1?\d{1,2}|2[0-4]\d|25[0-5])){2}(?:\.(?:[1-9]\d?|1\d\d|2[0-4]\d|25[0-4]))|(?:(?:[a-z0-9\u00a1-\uffff][a-z0-9\u00a1-\uffff_-]{0,62})?[a-z0-9\u00a1-\uffff]\.)+(?:[a-z\u00a1-\uffff]{2,}\.?))(?::\d{2,5})?(?:[/?#]\S*)?$/i
{
  "success": false,
  "error": "Invalid url provided.",
  "code": 1073
}

{
  "success": true,
  "data": {
    "code": "",
    "createdAt": "0000-00-00T00:00:00.000Z",
    "modifiedAt": "0000-00-00T00:00:00.000Z", // nullable
    "url": "",
    "pos": 0,
    "credit": "",
    "fullURL": "https://yiff.rocks/{code}",
    "managementCode": null
  }
}

{
  "success": true,
  "data": {
    "code": "",
    "createdAt": "0000-00-00T00:00:00.000Z",
    "modifiedAt": "0000-00-00T00:00:00.000Z", // nullable
    "url": "",
    "pos": 0,
    "credit": "",
    "fullURL": "https://yiff.rocks/{code}",
    "managementCode": "" // nullable, save if you plan on editing later
  }
}

Get A Short URL (Redirect)

GET https://yiff.rocks/:code

// Redirected to original url

Get A Short URL (Preview)

GET https://yiff.rocks/:code+

// HTML Page

Get A Short URL (JSON)

GET https://yiff.rocks/:code.json

{
  "success": true,
  "data": {
    "code": "",
    "createdAt": "0000-00-00T00:00:00.000Z",
    "modifiedAt": "0000-00-00T00:00:00.000Z", // nullable
    "url": "",
    "pos": 0,
    "credit": "",
    "fullURL": "https://yiff.rocks/{code}"
  }
}

Delete A Short URL

DELETE https://yiff.rocks/:code

If Read Only is enabled, a 503 Service Unavailable will be returned.

Request Body

Name

Type

Description

managementCode*

String

The management code you received when creating the shorturl.

{
  "success": false,
  "error": "You must provide an authorization code. These are created at the time the short url was created.",
  "code": 1076
}

Modify A Short URL

PATCH https://yiff.rocks/:code

If Read Only is enabled, a 503 Service Unavailable will be returned.

Request Body

Name

Type

Description

managementCode*

String

The management code you received when creating the shorturl.

credit

String

The new credit name for the url.

url

String

The new url for the shorturl.

{
  "success": false,
  "error": "You must provide an authorization code. These are created at the time the short url was created.",
  "code": 1076
}

// RegEx: /^(?:(?:(?:https?|ftp):)?\/\/)(?:\S+(?::\S*)?@)?(?:(?!(?:10|127)(?:\.\d{1,3}){3})(?!(?:169\.254|192\.168)(?:\.\d{1,3}){2})(?!172\.(?:1[6-9]|2\d|3[0-1])(?:\.\d{1,3}){2})(?:[1-9]\d?|1\d\d|2[01]\d|22[0-3])(?:\.(?:1?\d{1,2}|2[0-4]\d|25[0-5])){2}(?:\.(?:[1-9]\d?|1\d\d|2[0-4]\d|25[0-4]))|(?:(?:[a-z0-9\u00a1-\uffff][a-z0-9\u00a1-\uffff_-]{0,62})?[a-z0-9\u00a1-\uffff]\.)+(?:[a-z\u00a1-\uffff]{2,}\.?))(?::\d{2,5})?(?:[/?#]\S*)?$/i
{
  "success": false,
  "error": "Invalid url provided.",
  "code": 1073
}

{
  "success": true,
  "data": {
    "code": "",
    "createdAt": "0000-00-00T00:00:00.000Z",
    "modifiedAt": "0000-00-00T00:00:00.000Z", // nullable
    "url": "",
    "pos": 0,
    "credit": "",
    "fullURL": "https://yiff.rocks/{code}"
  }
}

PreviousThumbnails NextShared Responses

Last updated 2 years ago

Was this helpful?