>_ NicAPI Dokumentation

REST-API von LUMASERV: Domains, DNS, SSL, Cloud-Server, IP-Adressen, Abrechnung und mehr.

  1. Einführung
  2. Weiteres

Weiteres / Dokumentation

GET Dokumentation abrufen API v1

GET https://connect.nicapi.eu/api/v1/misc/docs/routes

Diese Funktion gibt alle Routen und Parameter als JSON zurück.

Authentifizierung
keine (öffentlicher Endpunkt)

Dieser Endpunkt benötigt neben der Authentifizierung keine weiteren Request-Parameter.

curl \
  "https://connect.nicapi.eu/api/v1/misc/docs/routes"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("misc/docs/routes");

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

Weiteres / Nachrichten

GET Einzelne Nachricht abrufen API v1

GET https://connect.nicapi.eu/api/v1/misc/language/message/{message}

Gibt Informationen über eine einzelne Nachricht zurück.

Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
message Pflicht Identifikator: Nachricht Identifikator (key) des Objekts „Message“, Teil des Pfads.

Dieser Endpunkt benötigt neben der Authentifizierung keine weiteren Request-Parameter.

curl \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/misc/language/message/{message}"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("misc/language/message/{message}");

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

GET Nachrichten abrufen API v1

GET https://connect.nicapi.eu/api/v1/misc/language/messages

Gibt alle in unserem System verwendeten Nachrichten zurück.

Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)

Dieser Endpunkt benötigt neben der Authentifizierung keine weiteren Request-Parameter.

curl \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/misc/language/messages"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("misc/language/messages");

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

Weiteres / News

GET News abrufen API v1

GET https://connect.nicapi.eu/api/v1/misc/news
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
NEWS

Dieser Endpunkt benötigt neben der Authentifizierung keine weiteren Request-Parameter.

curl \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/misc/news"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("misc/news");

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

Weiteres / TeamSpeak-Instanzen

GET TeamSpeak-Instanzen abrufen API v1

GET https://connect.nicapi.eu/api/v1/misc/teamspeak-instances

Gibt alle zugewiesenen TeamSpeak-Instanzen zurück.

Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
TEAMSPEAK_LIST

Dieser Endpunkt benötigt neben der Authentifizierung keine weiteren Request-Parameter.

curl \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/misc/teamspeak-instances"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("misc/teamspeak-instances");

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

GET Teamspeak Instances: Statistics API v1

GET https://connect.nicapi.eu/api/v1/misc/teamspeak-instances/statistics
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
TEAMSPEAK_LIST

Dieser Endpunkt benötigt neben der Authentifizierung keine weiteren Request-Parameter.

curl \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/misc/teamspeak-instances/statistics"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("misc/teamspeak-instances/statistics");

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}

GET Einzelne Instanz abrufen API v1

GET https://connect.nicapi.eu/api/v1/misc/teamspeak-instances/{teamspeak_instance}

Gibt Informationen über eine einzelne TeamSpeak-Instanz zurück.

Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
TEAMSPEAK_LIST

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
teamspeak_instance Pflicht Identifikator: TeamSpeak-Instanz Identifikator (id) des Objekts „Teamspeak Instance“, Teil des Pfads.

Dieser Endpunkt benötigt neben der Authentifizierung keine weiteren Request-Parameter.

curl \
  -H "Authorization: Bearer IHR_API_TOKEN" \
  "https://connect.nicapi.eu/api/v1/misc/teamspeak-instances/{teamspeak_instance}"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("misc/teamspeak-instances/{teamspeak_instance}");

if (NicAPI::wasSuccess()) {
    $data = $result->data;
}