>_ NicAPI Dokumentation

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

  1. Einführung
  2. Abrechnung
  3. Verträge

Abrechnung / Verträge

GET Verträge abrufen API v1

GET https://connect.nicapi.eu/api/v1/accounting/contracts

Gibt alle zugewiesenen Verträge zurück.

Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
CONTRACTS_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/accounting/contracts"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("accounting/contracts");

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

GET Vertragspositionen abrufen API v1

GET https://connect.nicapi.eu/api/v1/accounting/contracts/positions

Gibt alle zugewiesenen Vertragspositionen zurück.

Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
CONTRACTS_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/accounting/contracts/positions"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("accounting/contracts/positions");

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

GET Contracts: Positions Statistics API v1

GET https://connect.nicapi.eu/api/v1/accounting/contracts/positions/statistics
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
CONTRACTS_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/accounting/contracts/positions/statistics"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("accounting/contracts/positions/statistics");

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

GET Einzelne Vertragsposition abrufen API v1

GET https://connect.nicapi.eu/api/v1/accounting/contracts/positions/{contract_position}

Gibt Informationen zu einer einzelnen Vertragsposition zurück.

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

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
contract_position Pflicht Identifikator: Vertragsposition Identifikator (id) des Objekts „Contract Position“, 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/accounting/contracts/positions/{contract_position}"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("accounting/contracts/positions/{contract_position}");

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

GET Contracts: Statistics API v1

GET https://connect.nicapi.eu/api/v1/accounting/contracts/statistics
Authentifizierung
API-Token erforderlich (Authorization: Bearer … oder Parameter authToken)
Benötigte Rechte
CONTRACTS_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/accounting/contracts/statistics"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("accounting/contracts/statistics");

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

GET Einzelnen Vertrag abrufen API v1

GET https://connect.nicapi.eu/api/v1/accounting/contracts/{contract}

Gibt Informationen zu einem einzelnen Vertrag zurück.

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

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
contract Pflicht Identifikator: Vertrag Identifikator (id) des Objekts „Contract“, 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/accounting/contracts/{contract}"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("accounting/contracts/{contract}");

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

GET Rechnungspositionen zu Vertrag abrufen API v1

GET https://connect.nicapi.eu/api/v1/accounting/contracts/{contract}/last-billing-positions

Gibt alle aus einem Vertrag entstandenen Rechnungspositionen zurück.

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

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
contract Pflicht Identifikator: Vertrag Identifikator (id) des Objekts „Contract“, 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/accounting/contracts/{contract}/last-billing-positions"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("accounting/contracts/{contract}/last-billing-positions");

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

GET Positionen zu einzelnem Vertrag abrufen API v1

GET https://connect.nicapi.eu/api/v1/accounting/contracts/{contract}/positions

Gibt alle einem einzelnen Vertrag zugewiesenen Positionen zurück.

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

Pfad-Parameter Werden direkt in die URL eingesetzt.

Name Pflicht Typ Einschränkungen Beschreibung
contract Pflicht Identifikator: Vertrag Identifikator (id) des Objekts „Contract“, 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/accounting/contracts/{contract}/positions"
use NicAPI\NicAPI;

NicAPI::init("IHR_API_TOKEN");

$result = NicAPI::get("accounting/contracts/{contract}/positions");

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