Die Esadax REST API bietet mehrere Endpunkte zur Verwaltung von Zertifikaten. Mit diesen Endpunkten können Sie Zertifikate abrufen, erstellen, aktualisieren und löschen, die Ihrem Konto oder Team zugeordnet sind.
Übersicht
Die Certs API ermöglicht die Interaktion mit Zertifikatseinträgen, die im Esadax-System gespeichert sind. Jedes Zertifikat kann durch seine eindeutige id identifiziert werden und ist einem bestimmten Team zugeordnet. Die API unterstützt verschiedene Vorgänge wie das Abrufen eines Zertifikats nach ID, die Ausstellung neuer Zertifikate, die Aktualisierung vorhandener Zertifikate und deren Löschung.
Endpunkte
1 SGB V. Zertifiziert nach ID
- Methode: GET
- URL:
/v7/certs/{id} - Pfadparameter:
id(erforderlich) - Abfrageparameter:
slug,teamId - Antwort: Gibt die Zertifikatdetails einschließlich
autoRenew,cns,createdAt,expiresAtundidzurück.
Zwei. Ausstellen eines neuen Zertifikats
- Methode: POST
- URL:
/v7/certs - Abfrageparameter:
slug,teamId - Request Body: Enthält ein Array von Common Name Strings (CNS) unter dem Schlüssel
cns. - Response: Gibt die neu erstellten Zertifikatsdetails zurück.
3. Ein Zertifikat hochladen
- Methode: PUT
- URL:
/v7/certs - Abfrageparameter:
slug,teamId - Request Body: Enthält
ca(Zertifizierungsstelle),cert(Zertifikatsinhalt),key(privater Schlüssel) und optionalskipValidation. - Response: Gibt die aktualisierten Zertifikatdetails zurück.
4. Löschen eines Zertifikats
- Methode: DELETE
- URL:
/v7/certs/{id} - Pfadparameter:
id(erforderlich) - Abfrageparameter:
slug,teamId - Antwort: Entfernt das angegebene Zertifikat aus dem System.
Authentifizierung
Alle API-Aufrufe erfordern ein Autorisierungs-Token, das in den Anfrage-Headern als Authorization: Bearer {token} enthalten sein sollte.
Antwortcodes
Die API verwendet Standard-HTTP-Statuscodes, um Erfolg oder Fehler anzuzeigen. Hier ein Beispiel:
- 200 OK: Zeigt einen erfolgreichen Vorgang an.
- 400 Bad Request: Wenn es ein Problem mit den Anforderungsparametern gibt.
- 403 Forbidden: Wenn der Benutzer nicht über die erforderlichen Berechtigungen verfügt, um die Aktion auszuführen.
Diese Dokumentation enthält umfassende Informationen zur Interaktion mit dem Zertifikatsverwaltungssystem von Esadax über die REST-API. Stellen Sie sicher, dass Sie die spezifischen Anforderungen für jeden Endpunkt überprüfen, bevor Sie sie in Ihrer Anwendung implementieren.
