24fire-api
Version:
Nutze die 24fire api in Nodejs, sicher und schnell
184 lines (129 loc) • 5.08 kB
Markdown
[](https://forthebadge.com)
# 24fire-api
Die 24fire-api soll die Interaktion mit der 24fire Kunden Api vereinfachen und verbessern.
## Features
- 🔗 Kommunikation über SSL
- 🏃 Schnelle interaktion
- ➡️ Direkte Anfragen ohne Middelware
- ℹ️ Einfache Bedienung
- 🆕 Neuste Version
## Optimierungen & Feedback
Welche Optimierungen hast du in deinem Code vorgenommen? Z.B. Refactoring, Performance-Verbesserungen
Wenn du Feedback hast, wenden dich an mich unter support@flostechnikwelt.de
## Author & Credits
- Flostechnikwelt
- Lars.1309
## Empfehlenswert
- [Offizielle API Dokumentation](https://documenter.getpostman.com/view/18955936/2s93zB6hJu)
- [24fire](https://24fire.de/)
- [Discord](https://discord.gg/24fire)
## Wie wird es installiert?
Um die 24fire-api in deinem Projekt zu installieren, führe bitte den folgenden Befehl aus
```bash
npm install 24fire-api
```
## Wie bekomme ich einen API Key?
Jeder Kunde hat die möglichkeit für seine VM einen API-Key zu bekommen.
#### 1. Wähle deinen Server aus
#### 2. Öffne das Menu durch den Buttn mit den drei Strichen
#### 3. Klicke auf "API-Key anzeigen"
#### 4. Nun sollte dieses Modal erscheinen, hier kannst du den API-Key kopieren
## Wie verwende ich fireapi-24fire?
### Einen fireApi Client erstellen
```javascript
const fireApi = require("24fire-api")
const apiKey = 'DEIN_API_SCHLÜSSEL';
const myFireApi = new fireApi(apiKey);
```
### VM
#### -> Zeige die VM Konfiguration an
```javascript
myFireApi.vm().getVMconfig().then(data => {
console.log('VM config:', data);
}).catch(error => {
console.error('Fehler:', error);
});
```
#### -> Den aktuellen VM Status Abrufen
```javascript
myFireApi.vm().getVMstatus().then(data => {
console.log('Aktueller VM Status:', data);
}).catch(error => {
console.error('Fehler:', error);
});
```
#### -> Die VM Starten
```javascript
myFireApi.vm().startVM().then(data => {
console.log('Antwort: ', data);
}).catch(error => {
console.error('Fehler: ', error);
});
```
#### -> Die VM herunterfahren
```javascript
myFireApi.vm().stopVM().then(data => {
console.log('Antwort: ', data);
}).catch(error => {
console.error('Fehler: ', error);
});
```
#### -> Die VM neustarten
```javascript
myFireApi.vm().restartVM().then(data => {
console.log('Antwort:', data);
}).catch(error => {
console.error('Fehler:', error);
});
```
### Backup
#### -> Alle Backups auflisten
```javascript
myFireApi.backup().listBackups().then(data => {
console.log('Backup List:', data);
}).catch(error => {
console.error('Fehler:', error);
});
```
#### -> Ein neues Backup erstellen
```javascript
myFireApi.backup().createBackup(description).then(data => {
console.log('Antwort:', data);
}).catch(error => {
console.error('Fehler:', error);
});
```
| Parameter | Type | Description |
| :-------- | :------- | :-------------------------------- |
| `description` | `string` | **Optional**. Es kann optional ein Beschreibung hinzugefügt werden. |
#### -> Ein Backup Löschen
```javascript
myFireApi.backup().deleteBackup(backupId).then(data => {
console.log('Antwort: ', data);
}).catch(error => {
console.error('Fehler: ', error);
});
```
| Parameter | Type | Description |
| :-------- | :------- | :-------------------------------- |
| `backupId` | `string` | **Benötigt**. Die ID vom Backup welches gelöscht werden soll. |
### Monitoring
#### -> Alle Messungen vom Server Abrufen
```javascript
myFireApi.monitoring().getStats().then(data => {
console.log('Alle Messungen:', data);
}).catch(error => {
console.error('Fehler:', error);
});
```
#### -> Alle Ausfälle abrufen
```javascript
myFireApi.monitoring().retieceOutages().then(data => {
console.log('Antwort:', data);
}).catch(error => {
console.error('Fehler:', error);
});
```