Erste Schritte

Ihr erster Request in 4 Schritten

Von null zum echten API-Aufruf gegen die Openprovider REST API.

1

Konto anlegen und API-Zugang aktivieren

Sie brauchen ein aktives Reseller-Konto. Melden Sie sich im Kontrollzentrum an, oder legen Sie eines an, um Benutzername und Passwort zu erhalten.

Der API-Zugang ist standardmäßig deaktiviert und wird je Kontaktperson freigeschaltet. Gehen Sie im Kontrollzentrum zu Kontoübersicht → Kontaktpersonen → und wählen Sie Kontaktperson hinzufügen oder eine bestehende aus → Reiter API → API-Zugang aktivieren.

Für Domain-Vorgänge müssen Sie unter Umständen zuerst bestimmte Registry-Verträge unterzeichnen. Sie finden diese unter Konto → Verträge.

2

Für ein Bearer-Token authentifizieren

Senden Sie Ihre Zugangsdaten an den Endpunkt /auth/login. Die Antwort enthält ein Token, mit dem Sie jeden weiteren Request autorisieren.

curl -X POST https://api.openprovider.eu/v1/auth/login \
  -H 'Content-Type: application/json' \
  -d '{
    "username": "you@example.com",
    "password": "your-password",
    "ip": "0.0.0.0"
  }'

Das Token steht in data.token und ist zeitlich begrenzt gültig. Legen Sie es im Cache ab und verwenden Sie es über mehrere Requests hinweg, statt sich bei jedem Aufruf neu anzumelden.

3

Ersten autorisierten Aufruf senden

Übergeben Sie das Token im Authorization-Header als Bearer-Token. Hier prüfen wir, ob eine Domain verfügbar ist:

curl -X POST https://api.openprovider.eu/v1/domains/check \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "domains": [{ "name": "mybrand", "extension": "com" }]
  }'
4

Die vollständige API-Referenz ansehen

Sehen Sie jeden Endpunkt, jedes Request-Schema und jedes Antwortbeispiel in der interaktiven Dokumentation, oder importieren Sie die OpenAPI-Spezifikation in Postman.

Basis-URL und Konventionen

PunktWert
Basis-URLhttps://api.openprovider.eu/v1
ProtokollNur HTTPS
FormatRequest- und Response-Bodies in JSON
AuthentifizierungAuthorization: Bearer <token>
MethodenGET, POST, PUT, DELETE

Aufbau der Antwort

Erfolgreiche Antworten verpacken die Payload in einer festen Struktur mit einem numerischen code (0 steht für Erfolg) und einem data-Objekt:

{
  "code": 0,
  "data": { /* result */ },
  "desc": ""
}

Ein code ungleich null steht für einen Fehler. Prüfen Sie desc für die lesbare Meldung und fangen Sie Fehler in Ihrer Integration sauber ab.