API Schnittstelle
Sprich mit deinem Account über deine Lieblings-Programmiersprache
DEV + PPH = ❤️
Nutzungsmöglichkeiten der Prepaid-Hoster API
Eine API (Application Programming Interface) ist ein Satz von Werkzeugen und Protokollen, die es ermöglichen, verschiedene Softwarekomponenten zu integrieren. Im Kontext Ihres Hosting-Unternehmens ermöglicht Ihre API den Kunden, verschiedene Funktionen programmatisch zu steuern, was eine erhebliche Flexibilität und Automatisierungsmöglichkeiten bietet.
Seit bereits 2019 wird an der API gearbeitet. Jede neue Funktionalität, die im VionityCP eingebaut wird, wird zunächst in der API implementiert. VionityCP greift im Hintergrund dann auf diese API zurück. Kunden können somit auf das Herzstück zugreifen. Vollumfänglich!
Automatisierung: Kunden können Routineaufgaben wie das Einrichten, Verwalten und Überwachen von Linux Root Servern automatisieren. Dies spart Zeit und reduziert menschliche Fehler.
Integration mit bestehenden Systemen: Kunden können die API in ihre bestehenden Systeme und Anwendungen integrieren, um einen nahtlosen Workflow zu schaffen.
Anpassung: Durch die API können Kunden spezifische Funktionen nach ihren Bedürfnissen anpassen und erweitern.
Skalierbarkeit: Kunden können ihre Serverressourcen je nach Bedarf dynamisch anpassen.
Spannende Beispiele
Server stoppen
Mit der Prepaid-Hoster API kannst Du beispielsweise Deinen Server programmatisch herunterfahren. Wie wäre es, wenn Du dir einen eigenen Discord Bot schreibst, mit welchem Du den Status deines Servers checken kannst?
// Send shutdown signal to server
fetch("https://api.pph.sh/client/hosting/12345/action/write/stop", {
method: "POST",
headers: {
"Authorization": "Bearer TOKEN",
"Content-Type": "application/json"
}
})
.then(r => r.json())
.then(function (r) {
console.log(r);
});
// Response after 6.392s
{
"success": true
}
Command auf Server ausführen
Du kannst beispielsweise über die API einen Command an deinen Server senden. Die Antwort des Commands erhältst Du in der API-Response. So kannst du beispielsweise mit Applikationn auf deinem
// Send command to server
fetch("https://api.pph.sh/client/hosting/12345/action/write/exec", {
method: "POST",
headers: {
"Authorization": "Bearer TOKEN",
"Content-Type": "application/json"
},
body: JSON.stringify({
"command": "find /opt/backup -type f -mtime +30 -delete"
})
})
.then(r => r.json())
.then(function (r) {
console.log(r);
});
// Response after 2.932s
{
"data": {
"success": true,
"command": "find /opt/backup -type f -mtime +30 -delete",
"output": "",
"exitCode": 0
}
}
Server bestellen
Über die API kannst Du sogar Server problemlos und einfach bestellen! Sobald dein neuer Server eingerichtet ist, kannst du ihn sofort über die API verwalten.
const apiEndpoint = 'https://api.pph.sh/virtual-cart/order/place/';
const token = 'Dein_API_Key'; // API Key aus vionity.de
const orderDetails = {
pid: 269, // Produkt-ID
configOptions: {
cpu: 4, // Anzahl der CPU-Kerne
ram: 4, // RAM in GB
space: 100 // Speicherplatz in GB
}
};
fetch(apiEndpoint, {
method: "POST",
headers: {
"Authorization": `Bearer $`,
"Content-Type": "application/json"
},
body: JSON.stringify(orderDetails)
})
.then(response => response.json())
.then(data => {
console.log(data);
})
.catch(error => {
console.error('Error:', error);
});
// Response after 0.563ms...
{
"data": {
"success": true,
"placed": true,
"transaction": {
"amount": 3.12,
"uuid": "faf113c9-9f40-4ae9-87db-0ad65d9428d0",
"updated_at": "2021-05-10T00:53:13.000000Z",
"created_at": "2021-05-10T00:53:13.000000Z",
"id": 20
},
"cart": {
"label": "Cart",
"items": [
{
"label": "Linux vServer Power Duo",
"price": 3.12,
"meta": []
}
],
"sum": 3.12
}
}
}
Produkt-Infos abrufen
Du willst ein richtiger Pfennig-Fuchser sein? Bastel dir deinen eigenen Promocode-Alarm für bestimmte Server! Zuschlagen, wenn es wieder 30% dauerhafter Rabatt sind!
// Produkt ID für KVM Root Server: 269
fetch('https://api.pph.sh/public/products/269/')
.then(response => response.json())
.then(response => {
console.log(response.data);
// Aktueller Gutschein: response.data.promocode_info.code
})
.catch(error => {
console.error('Error:', error);
});
// Response after 0.363s...
{
"data": {
"id": 269,
"name": "KVM Root Server",
"group": "AMD SSD KVM vServer",
"group_id": 64,
"general_promocode": "KVMNOV23",
"promocode_info": {
"code": "KVMNOV23",
"label": "KVMNOV23 = 1x 25%",
"recurring": false,
"recurring_for": null,
"recurring_infinite": false,
"value": 25,
"type": "Percentage"
},
"promotion": false,
"historic_min": 0,
"price_range": {
"min": 5.23,
"max": 56.93,
"same": false
},
"price_range_default": {
"min": 6.98,
"max": 75.91,
"same": false
},
"availability": {
"status": "out_of_stock",
"wait": true,
"wait-time": {
"min": 3,
"max": 11,
"unit": "Stunde(n)"
},...
Handle in deinem Namen
Kundenspezifisch
Die OpenAPI-Spezifikation für die /client/ Endpunkte Ihrer API bietet eine Reihe von Funktionen, die für Kunden von großem Nutzen sein können. Hier sind einige der Möglichkeiten in Stichpunkten zusammengefasst:
Endpunkt: api.pph.sh/client
Verwaltung von Hosting-Diensten: Kunden können Details ihrer Hosting-Services abrufen und verwalten, einschließlich Serverinformationen wie IP-Adresse, Betriebssystem, CPU-Kerne, RAM, SSD-Speicher und mehr.
Kontostatus und Abrechnung: Kunden können den Status ihres Kontos überprüfen, einschließlich Abrechnungszyklen, offene Rechnungen, Fälligkeitsdaten und Zahlungsdetails.
Promotions und Angebote: Kunden können verfügbare Promotionen und Angebote einsehen und nutzen, einschließlich wiederkehrender Rabatte.
Server-Management: Zugriff auf das Server-Webinterface für die Verwaltung und Konfiguration von Hosting-Diensten.
Paketoptionen: Kunden können zwischen verschiedenen Hosting-Paketen wählen und ihre aktuellen Pakete anpassen.
Erkennung von Problemen: Die API kann eine Liste automatisch erkannter Probleme im Zusammenhang mit dem Kundenkonto zurückgeben.
Live-Aktionen zu Hostings
Server-Neustart und Wartung: Kunden können ihre Server live neustarten oder Wartungsaktionen durchführen, was für die Aufrechterhaltung und das Management der Serverleistung entscheidend ist.
Ressourcenanpassung in Echtzeit: Die Möglichkeit, Hosting-Ressourcen wie CPU, RAM und Speicherplatz dynamisch anzupassen, ermöglicht eine flexible Skalierung entsprechend der aktuellen Bedürfnisse.
Live-Monitoring: Kunden können den Status und die Leistung ihrer Hostings in Echtzeit überwachen, was für die schnelle Erkennung und Behebung von Problemen wichtig ist.
Domain-Aktionen
DNS-Verwaltung: Kunden können DNS-Einträge für ihre Domains setzen, ändern und abrufen. Dies ermöglicht eine umfassende Kontrolle über die Domain-Namensauflösung und ist entscheidend für die Verwaltung von Webseiten und E-Mail-Diensten.
Nameserver-Änderungen: Kunden können die Nameserver ihrer Domains ändern, um ihre Hosting-Provider zu wechseln oder um fortschrittlichere DNS-Dienste zu nutzen.
Neue Domain-Registrierungen: Über die API können Kunden neue Domains registrieren, was die Einrichtung neuer Webprojekte vereinfacht und beschleunigt.
Statistiken und Analysen
Traffic- und Nutzungsstatistiken: Kunden können detaillierte Statistiken über den Datenverkehr und die Nutzung ihrer Hosting-Dienste abrufen, was für die Analyse der Webseitenleistung und für Kapazitätsplanungen nützlich ist.
Performance-Analyse: Durch die Erfassung und Analyse von Leistungsdaten können Kunden Engpässe identifizieren und Optimierungen vornehmen.
Ausfallzeiten und Verfügbarkeitsberichte: Die API könnte auch Statistiken über Ausfallzeiten und die allgemeine Verfügbarkeit der gehosteten Dienste liefern, was für die Überwachung der Servicequalität wesentlich ist.
