Ry.hk Ry.hk

API

Verwalten Sie Domains über ein Programm und nicht jeweils über eine Seite.

Überweisungsregistrierung, Verfügbarkeitsprüfungen, DNS und Verwaltung in Ihre eigenen Systeme: Großbestellungen, Erneuerungsprüfungen, ein Control Panel für Ihre Kunden.

API ist der Maschineneinstiegspunkt für dieselben Vorgänge, die der Clientbereich anbietet. Was Sie auf einer Seite tun können, können Sie per Skript ausführen.

RUHE HTTPS mit JSON-Antworten
API-Schlüssel Im Kundenbereich angelegt und widerrufen
Vollständige Abdeckung Die gleichen Vorgänge wie im Kundenbereich
Überprüfbar Anrufe werden auf dem Konto aufgezeichnet

Was es ist

  • Endpunkte werden nach Ressourcen gruppiert – Verfügbarkeit, Domänen, Nameserver, Kontakte, Bestellungen und Rechnungen – und geben JSON zurück.
  • Die Authentifizierung erfolgt über einen im Client-Bereich generierten API-Schlüssel, der jederzeit widerrufen und ersetzt werden kann.
  • Typische Anwendungen: Massenregistrierung, Ablaufprüfungen, Synchronisierung des Domänenstatus mit Ihrem eigenen System, ein Self-Service-Panel für Kunden und automatisierte Zertifikats-Workflows.
  • Es gelten die gleichen Geschäftsregeln wie im Internet: Eine Domain kann nicht aus dem Nichts registriert werden, und für eine Übertragung sind immer noch eine freigeschaltete Domain und 60 Tage erforderlich.

Wie es funktioniert

01

Erstellen Sie einen Schlüssel

Generieren Sie einen API-Schlüssel im Client-Bereich, der auf seine Aufgaben beschränkt ist.

02

Lesen Sie die Dokumentation

Endpunkte, Parameter und Antwortformen.

03

Klein testen

Probieren Sie vor der Automatisierung schreibgeschützte Endpunkte oder einige Domänen aus.

04

Gehen Sie mit der Protokollierung live

Fügen Sie Wiederholungsversuche und Protokollierung hinzu, bevor es in die Produktion geht.

Verfügbarkeit und Suche

Überprüfen Sie viele Namen gleichzeitig zur Überwachung und Auswahl.

Registrierung und Verlängerung

Bestellen, verlängern und Bestellstatus lesen.

DNS und Nameserver

Pushen Sie Datensätze und Nameserver-Änderungen in großen Mengen.

Kontaktverwaltung

Lesen und aktualisieren Sie Registrant, Admin, Technik und Abrechnung.

Bestellungen und Rechnungen

Lesen Sie Bestellungen, Rechnungen und Zahlungsstatus.

Schlüsseldrehung

Schlüssel widerrufen und ersetzen; Behalten Sie jedes System auf einem eigenen Schlüssel.

Was die API abdeckt

Nach Ressource

RessourceWas Sie tun können
DomänenVerfügbarkeit prüfen, registrieren, erneuern, Status und Ablauf lesen
DNSNameserver lesen und festlegen, DNS-Datensätze pflegen
Datenschutz und KontakteLegen Sie die Datenschutzstufe fest und aktualisieren Sie alle vier Kontaktrollen
Bestellungen und AbrechnungLesen Sie Bestellungen, Rechnungen und Zahlungsstatus
KontoLesen Sie den Kontostand und die grundlegenden Kontodaten

Was muss vor der Verbindung vorhanden sein?

Vier kleine Dinge, die den größten Teil des Debuggens ersparen

  • Guthaben oder eine funktionierende Zahlungsmethode: Registrierung und Verlängerung sind echte Bestellungen und ein Anruf schlägt im Bestellschritt ohne Guthaben fehl.
  • Wiederholungsversuche und Fehlerbehandlung: Es kommt zu Netzwerkfehlern, Ratenbegrenzungen und Upstream-Verzögerungen. Idempotente Lesevorgänge wiederholen; Senden Sie bei Bestellungen eine eindeutige Referenz und überprüfen Sie diese, bevor Sie erneut schreiben.
  • Protokollierung: Zeichnen Sie die Referenz, die Domäne und den Antwortcode auf. Wenn etwas später umstritten ist, sind diese Protokolle der einzige Beweis dafür, dass die Aktion stattgefunden hat.
  • Geringeste Berechtigung: Verwenden Sie keinen beschreibbaren Schlüssel für einen schreibgeschützten Job und geben Sie jedem System einen eigenen Schlüssel, damit einer widerrufen werden kann, ohne die anderen zu zerstören.

Ein API-Schlüssel entspricht einem Kontokennwort. Bewahren Sie es in einer serverseitigen Umgebungsvariablen oder einem Secrets-Manager auf, niemals im Front-End-Code und niemals in einem Repository.

Wie Menschen es nutzen

Gemeinsame Muster

  • Massenregistrator: Senden Sie eine Auswahl zur Registrierung und schreiben Sie die Ergebnisse zurück in Ihr eigenes Backend.
  • Erneuerungs-Sweeps: Rufen Sie jede Nacht Domains ab, die kurz vor dem Ablauf stehen, und lösen Sie Ihre eigenen Erinnerungs- oder Erneuerungsaufgaben aus.
  • White-Label-Panels: Ermöglichen Sie Ihren Kunden, Domains innerhalb Ihres Produkts zu verwalten, ohne sich hier anzumelden.
  • Abgleich: Rufen Sie Domain- und Bestelldaten nach einem Zeitplan ab und gleichen Sie sie mit Ihrem eigenen Hauptbuch ab.

Was jede Bestellung beinhaltet

API Schlüsselverwaltung

Erstellen, widerrufen und trennen Sie Schlüssel nach Zweck.

Dokumentation

Endpunkte, Parameter und Antworten.

Domäne und DNS-Endpunkte

Suchen, registrieren, erneuern, DNS und Nameserver.

Bestell- und Abrechnungsendpunkte

Bestellungen, Rechnungen und Zahlungsstatus.

Anrufverlauf

Zur Fehlerbehebung für das Konto aufgezeichnet.

Unterstützung

Öffnen Sie ein Ticket, wenn sich eine Integration nicht richtig verhält.

Häufige Fragen

Gibt es einen Aufpreis für API?

Der API selbst wird nicht separat berechnet; Sie zahlen für die Geschäftstätigkeit, die es durchführt. Um eine versehentliche oder missbräuchliche Nutzung zu verhindern, gibt es eine sinnvolle Tarifbegrenzung.

Gibt es ein SDK?

API ist standardmäßig HTTPS und JSON, sodass jeder HTTP-Client funktioniert. In der Dokumentation sind Anforderungsbeispiele enthalten, die direkt angepasst werden können.

Was passiert, wenn ein Schlüssel undicht ist?

Widerrufen Sie es im Kundenbereich und generieren Sie ein neues. Der Widerruf wird sofort wirksam und Anfragen mit dem alten Schlüssel werden abgelehnt.

Kostet das Testen etwas?

Nur-Lese-Anrufe kosten nichts. Registrierung und Verlängerung sind echte Aufträge und kosten Geld. Überprüfen Sie daher die Logik zunächst an einer kleinen Anzahl von Domains.

Kann API anderswo registrierte Domains verwalten?

Nein. Es funktioniert auf den Domänen in diesem Konto genau wie der Kundenbereich.

Bitte beachten Sie

  • Behalten Sie die API-Schlüssel auf dem Server. Ein im Browsercode oder einem Mobilpaket gelieferter Schlüssel ist ein veröffentlichter Schlüssel.
  • Senden Sie zum Bestellen von Endpunkten eine eindeutige Anforderungsreferenz und überprüfen Sie diese vor dem Schreiben, damit bei einem erneuten Netzwerkversuch keine doppelte Registrierung oder Gebühr erfolgt.

Bereit zum Start?

Öffnen Sie die Seite für diesen Service und schließen Sie den Vorgang in wenigen Schritten ab. Wenn Sie lieber zuerst fragen möchten, erreicht ein Ticket eine Person.