mirror of
https://github.com/shlinkio/shlink.git
synced 2024-12-27 01:11:39 -06:00
131 lines
4.5 KiB
JSON
131 lines
4.5 KiB
JSON
{
|
|
"get": {
|
|
"operationId": "shortenUrl",
|
|
"tags": [
|
|
"Short URLs"
|
|
],
|
|
"summary": "Create a short URL",
|
|
"description": "Creates a short URL in a single API call. Useful for third party integrations.",
|
|
"parameters": [
|
|
{
|
|
"$ref": "../parameters/version.json"
|
|
},
|
|
{
|
|
"name": "apiKey",
|
|
"in": "query",
|
|
"description": "The API key used to authenticate the request",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "longUrl",
|
|
"in": "query",
|
|
"description": "The URL to be shortened",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "format",
|
|
"in": "query",
|
|
"description": "The format in which you want the response to be returned. You can also use the \"Accept\" header instead of this",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string",
|
|
"enum": [
|
|
"txt",
|
|
"json"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "The list of short URLs",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "../definitions/ShortUrl.json"
|
|
}
|
|
},
|
|
"text/plain": {
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"examples": {
|
|
"application/json": {
|
|
"longUrl": "https://github.com/shlinkio/shlink",
|
|
"shortUrl": "https://doma.in/abc123",
|
|
"shortCode": "abc123",
|
|
"dateCreated": "2016-08-21T20:34:16+02:00",
|
|
"visitsCount": 0,
|
|
"tags": [
|
|
"games",
|
|
"tech"
|
|
],
|
|
"meta": {
|
|
"validSince": "2017-01-21T00:00:00+02:00",
|
|
"validUntil": null,
|
|
"maxVisits": 100
|
|
},
|
|
"domain": null
|
|
},
|
|
"text/plain": "https://doma.in/abc123"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "The long URL was not provided or is invalid.",
|
|
"content": {
|
|
"application/problem+json": {
|
|
"schema": {
|
|
"$ref": "../definitions/Error.json"
|
|
}
|
|
},
|
|
"text/plain": {
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"examples": {
|
|
"application/problem+json": {
|
|
"title": "Invalid URL",
|
|
"type": "INVALID_URL",
|
|
"detail": "Provided URL foo is invalid. Try with a different one.",
|
|
"status": 400,
|
|
"url": "https://invalid-url.com"
|
|
},
|
|
"text/plain": "INVALID_URL"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Unexpected error.",
|
|
"content": {
|
|
"application/problem+json": {
|
|
"schema": {
|
|
"$ref": "../definitions/Error.json"
|
|
}
|
|
},
|
|
"text/plain": {
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"examples": {
|
|
"application/problem+json": {
|
|
"error": "INTERNAL_SERVER_ERROR",
|
|
"message": "Unexpected error occurred"
|
|
},
|
|
"text/plain": "INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|