short3n.me API V.1.0 - Dokumentation
Im Rahmen der kostenlosen Mitgliedschaft, stellen wir eine kostenlose API zur Verfügung.
Diese API kann jeder registrierte User verwenden und somit diesen Dienst in eigene Erweiterungen
integrieren.
Für die Benutzung dieser API, benötigst du einen API-Key, welchen du in deinem Profil-Bereich findest.
Erweiterungen
Folgende Erweiterungen stehen bereits kostenlos zur Verfügung.
Neuen Shortlink via API anlegen
Um eine neue URL zu shorten, sende eine HTTP-Anfrage an folgende API-URL:
- https://short3n.me/api/v1/createlink
- key - Dein API-Key
- url - Die URL die geshortet werden soll
- status - Der HTTP-Status der für die Weiterleitung benutzt werden soll
Mögliche Werte: 301 / 302 - meta - true/false - Social Media Meta Daten faken?
- title - Meta-Title für Facebook und Twitter
- desc - Meta-Description für Facebook und Twitter
- image - Vorschaubild für Facebook und Twitter
Beispiel-Code:
var privateKey = 'YOUR_API_KEY';
var longUrl = 'https://url-that-should-be-shor3n.com';
var status = 301; // OR 302
var meta = true; // or false
var title = 'Your custom title for Facebook/Twitter';
var desc = 'Your custom Meta Description for Facebook/Twitter';
var image = 'Custom Image URL for Facebook/Twitter';
$.ajax({
url: 'https://short3n.me/api/v1/createlink',
type: 'post',
data: {
'key': privateKey,
'url': longUrl,
'status': status,
'meta': meta,
'title': title,
'desc': desc,
'image': image
},
success: function(data, status) {
// do what ever you want with json data
// json format on success
//{
// "message": "Shortlink erfolgreich angelegt",
// "link": "https:\/\/short3n.me\/456846"
//}
},
error: function(xhr, desc, err) {
// if your API-Key is wrong the api answers with response code 401
// if any required post data is empty, the api response with code 400
}
});
});
$post_data = [
'key' => 'YOUR_API_KEY',
'url' => 'https://url-that-should-be-shor3n.com',
'status' => 301,
'meta' => true,
'title' => 'Your custom title for Facebook/Twitter',
'desc' => 'Your custom Meta Description for Facebook/Twitter',
'image' => 'Custom Image URL for Facebook/Twitter'
];
$ch = curl_init('https://short3n.me/api/v1/createlink');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $post_data);
$response = curl_exec($ch);
curl_close($ch);
/*
* do anything you want with your response
* sample JSON output:
* {
* "message": "Shortlink erfolgreich angelegt",
* "link": "https:\/\/short3n.me\/0961"
*}
*/
$data = json_decode($response);
var_dump($data);
Shortlink Informationen abfragen
Über die API können Informationen zu einzelnen Shortlinks abgefragt werden.
API URL: https://short3n.me/api/v1/getshortlink
Benötigte POST-Parameter:
- key - API-Key
- url - Shortlink URL
$post = [
'key' => 'YOUR_API_KEY',
'url' => 'https://short3n.me/040cab',
];
$ch = curl_init('https://short3n.me/api/v1/getshortlink');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $post);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response);
/*
* sample json output
* {
* "message": "Abfrage erfolgreich",
* "target": "https:\/\/tobier.de\/tools\/backlink-checker\/",
* "parameter": "140cab",
* "status": "301",
* "meta": false,
* "title": "\u2713",
* "description": "Beispiel Description",
* "image": "https://short3n.me/myimage.png"
* }
**/
Shortlink Statistik abfragen
Unter dem API Endpunkt "getredirectstats" können alle durchgeführten Redirects eines bestimmten Shortlinks abgefragt werden. Hierfür müssen der API-Key und die Short-URL als POST-Parameter übergeben werden. Folgende Daten werden bei einem Redirect ausgelesen:
- Referer
- Device
- Betriebssystem
- Browser
- Redirect-Ziel
- Shortlink Parameter
- Datum und Uhrzeit des Redirects
$post = [
'key' => 'YOUR_API_KEY',
'url' => 'https://short3n.me/040cab',
];
$ch = curl_init('https://short3n.me/api/v1/getredirectstats');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $post);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
$data = json_decode($response);
Verwendete HTTP-Status-Codes
Die angebotene API gibt für unterschiedliche Situationen, unterschiedliche HTTP-Status-Codes aus. Folgende Codes können vorkommen:
- 200 - Abfrage erfolgreich
- 400 - POST-Daten fehlerhaft
- 401 - Authentifizierung fehlgeschlagen (ungültiger API-Key)
- 500 - Internal Error