Support:

08000 638 287

Mo-Fr. 10-18 Uhr (Kostenfrei aus dem deutschen Festnetz)

CCP API

Aus netcup Wiki
Wechseln zu: Navigation, Suche
Beachten Sie bitte auch unsere ausführliche technische Dokumentation der API und ihrer Methoden. Die technischen Informationen hier ergänzen diese Dokumentation.

Die APIs im CCP erlauben es Ihnen, programmatisch verschiedene Aktionen durchzuführen.

Inhaltsverzeichnis

Aktuell zur Verfügung stehende API-Dienste

  • DNS API
    • Mit der DNS-API können Sie Modifikationen an DNS-Zonen von Domains vornehmen, welche über unsere netcup Nameserver konnektiert sind, sowie Informationen über die DNS-Zonen und -Records erhalten.
  • Domainreselling API
    • Nur nach Abschluss eines Domainreselling-Vertrags mit uns nutzbar
    • Die API erlaubt es Ihnen, Domains zu registrieren und zu transferieren, Kontakthandles anzulegen, Domains Handles zuzuweisen und vieles mehr.

Authentifizierung

Beantragung eines API-Passworts und API-Keys

Für die Nutzung der API-Funktionen benötigen Sie ein API-Passwort, sowie einen API-Key. Wenn Sie mit uns einen Domainreselling-Vertrag geschlossen haben, können Sie in Ihrem CCP unter "Stammdaten" im Bereich "API Verwaltung" die nötigen Daten erhalten.

API-Passwort generieren

Api-pw-gen.png

Um das API-Passwort zu generieren, klicken Sie bitte auf den Button "API Passwort generieren". Das Passwort wird von uns generiert, es ist nicht möglich, ein eigenes Passwort zu hinterlegen.

Api-pw-anzeige.png

Beachten Sie bitte: Sobald Sie ein neues Passwort generieren, müssen Sie dieses direkt in Ihren Clients anpassen. Das Passwort für die API wird Ihnen einmalig in der Bestätigungsmeldung angezeigt. Sollten Sie dieses vergessen, müssen Sie ein neues Passwort generieren, denn pro Kundenkonto wird lediglich ein API-Passwort vergeben. Bewahren Sie das Passwort also gut auf.

API-Key erstellen

Api-key-gen.png

Um letztlich eine Verbindung mit der Schnittstelle herstellen zu können, benötigen Sie mindestens einen API-Key. Diesen können Sie ebenfalls im CCP unter "Stammdaten" erstellen. Bestätigen Sie dazu bitte die Bedingungen für die Nutzung der API mit einem Klick auf die Checkbox. Anschließend können Sie über den Button "API Key erstellen" einen Key für die Nutzung der Schnittstelle erstellen lassen.

Der API-Key wird von uns generiert und ist hinreichend lang, um eine hohe Sicherheit zu gewährleisten. Der API-Key wird Ihnen anschließend angezeigt und Sie können diesen in Ihren Clients implementieren.

Sie können mehrere API-Keys erzeugen und unabhängig voneinander auch wieder entfernen.

Api-key-remove.png

Authentifizierung an der API

Um die API nutzen zu können, müssen Sie sich authentifizieren. Jeder Job erfordert eine Authentifizierung mit gültiger Session in Form einer Session ID.

Bei Nutzung der login Methode übermitteln Sie an uns

  • Ihre Kundennummer
  • Ihren API-Key
  • Ihr API-Passwort

Sie erhalten von uns dann als return Wert eine generierte Session ID übermittelt, die Sie, zusammen mit dem API-Key, zur Nutzung der anderen Methoden benötigen. Durch Nutzung Ihrer Session ID sind Sie gegenüber unserer API authentifiziert.

Die Session läuft nach 15 Minuten Inaktivität automatisch ab. Alternativ können Sie die logout Methode nutzen. Diese führt zu einem direkten Ablauf der Session.

API-Log

In Ihrem CCP können Sie im Bereich "Domains" unter "Domain API Log" die zuletzt ausgeführten API-Aktionen ansehen. Falls Sie kein Domainreseller sind, erscheint der Button, sobald Sie mindestens eine API-Aktion ausgeführt haben.

Api log2.png

Sie finden dort den Zeitpunkt, die Aktion, den Status, eine kurze Rückmeldung, das Handle bzw. die Domain, auf die sich die Handlung bezieht, den verwendeten API-Key, sowie den Zeitpunkt, zu dem die Nachricht (mit ackpoll) gelesen wurde.

API-Log.png

Wie auch auf dem obigen Screenshot zu erkennen, werden Aktionen, die am gleichen Tag und in der gleichen Stunde, Minute und Sekunde durchgeführt werden, nicht zwangsläufig in chronologischer Reihenfolge dargestellt.

Über einen Klick auf die Lupe links neben der Aktion erhalten Sie eine lange Rückmeldung, die Request Message und die Response Message angezeigt. Ferner sehen Sie auch die Server Request ID, die Client Request ID, die Rückmeldungsnummer, sowie das verwendete Nachrichtenformat.

Die Rückmeldungsnummern orientieren sich an den üblichen Gruppen der HTTP-Fehlercodes:

  • 2*** Erfolgsmeldungen
  • 4*** Fehler tendenziell auf Kundenseite
  • 5*** Fehler tendenziell auf Serverseite

Technische Informationen

Im Folgenden erhalten Sie technische Informationen zur Nutzung der API.

Beachten Sie bitte die genaue Beschreibung aller Typen und Methoden. Die folgenden Informationen ergänzen diese.

API-Endpoint

Der API-Endpoint befindet sich unter folgender URI:

https://ccp.netcup.net/run/webservice/servers/endpoint.php

Allgemeine Informationen zu API-Requests

  • Input und Output erfolgt in UTF-8.
  • Domains die Sonderzeichen wie beispielsweise einen deutschen Umlaut enthalten, müssen vor der Übertragung in Punycode umgewandelt werden. Je nach Registrar kann es trotzdem sein, dass bestimmte Sonderzeichen nicht unterstützt werden. Sie erhalten dann eine Fehlermeldung.
  • Ändert sich die Rückmeldung seitens der Registry (z.B. bei einem Transfer von der Auftragsannahme "return receipt" zu "transfer successful", so wird die message bei einem poll erneut mit der neuen Rückmeldung übermittelt, auch wenn diese zuvor via ackpoll gelesen wurde.
  • Durchgeführte poll und ackpoll Aktionen werden Ihnen bei einem poll nicht angezeigt.

Validierung

  • Zur Validierung können die in der WSDL enthaltenen XSDs genutzt werden.


URI für SOAP-Requests

https://ccp.netcup.net/run/webservice/servers/endpoint.php?WSDL

Anmerkungen zu SOAP-Requests

  • Geben Sie bei einem SOAP-Aufruf im Client bitte die Parameter wie in der Funktion bzw. der WSDL beschrieben vor.
  • Verwenden sie zum Beispiel den von uns generierten SOAP Client

https://ccp.netcup.net/run/webservice/servers/endpoint.php?PHPSOAPCLIENT

    • Wir garantieren nicht die Fehlerfreiheit des Client. Auf dem Markt findet sich eine Vielzahl von kostenlosen Lösungen, die für die von Ihnen präferierte Sprache Code aus der WSDL erzeugen.

Anmerkungen zu JSON-Requests

Die Nachricht (payload) an den Server muss per POST erfolgen. Ein Login sieht z.B. wie folgt aus:

{
   "action":"login",
   "param":{
      "apikey":"xxxxxxxxxxxx",
      "apipassword":"xxxx",
      "customernumber":"123456"
   }
}

URI für JSON-Requests (REST)

https://ccp.netcup.net/run/webservice/servers/endpoint.php?JSON

Wichtige Anmerkungen zu JSON-Requests

  • Nutzen Sie die JSON-URI für Requests in REST-Form.
  • Die Parameterreihenfolge ist bei JSON-Requests irrelevant, da die Parameter per Key definiert werden.
Meine Werkzeuge
Namensräume

Varianten
Aktionen
netcup
Webhosting
vServer / Root-Server
Groupware
F.A.Q.
Sonstiges