Onboarding

Übersicht

| Beschreibung | Methode | Endpunkt | | ---------------------------------------------------------------------------- | ------- | ----------------------------------------------------------------------------------- | | Domain scannen | GET | /hosting/api/client/{clientId}/domain/{domainId}/onboarding/scan | | Vorlagen importieren | POST | /hosting/api/client/{clientId}/domain/{domainId}/onboarding/presets | | Einbindungen aus Cookies erzeugen | POST | /hosting/api/client/{clientId}/domain/{domainId}/onboarding/embeddingsFromCookies | | Code-Schnipsel zur Einbindung von CCM19 auslesen | GET | /hosting/api/client/{clientId}/domain/{domainId}/onboarding/embed |

Domain scannen

Endpunkt: /hosting/api/client/{clientId}/domain/{domainId}/onboarding/scan

Methode: GET

Query:

- {clientId}: string – Die ID eines CCM19-Kundenkontos - {domainId}: string – Die ID einer Domain, die in dem Kundenkonto vorhanden ist

Response:

- 200 – Erfolg - OnboardingScanResult - 400 – Die Website hat einen fehlerhaften Antwortcode oder einen leeren Inhalt gesendet - 404 – Ressource nicht gefunden - 500 – Beim Crawlen der Website ist ein Problem aufgetreten

Vorlagen importieren

Endpunkt: /hosting/api/client/{clientId}/domain/{domainId}/onboarding/presets

Methode: POST

Query:

- {clientId}: string – Die ID eines CCM19-Kundenkontos - {domainId}: string – Die ID einer Domain, die in dem Kundenkonto vorhanden ist

Payload: OnboardingPreset[]

Response:

- 201 – Ressource erfolgreich erzeugt - OnboardingPresetResult[] - 400 – Ungültige oder fehlende Eigenschaften - 404 – Ressource nicht gefunden

Einbindungen aus Cookies erzeugen

Endpunkt: /hosting/api/client/{clientId}/domain/{domainId}/onboarding/embeddingsFromCookies

Methode: POST

Query:

- {clientId}: string – Die ID eines CCM19-Kundenkontos - {domainId}: string – Die ID einer Domain, die in dem Kundenkonto vorhanden ist

Payload: OnboardingCookie[]

Response:

- 201 – Ressource(n) erfolgreich erzeugt - 400 – Ungültige oder fehlende Eigenschaften - 404 – Ressource nicht gefunden

Code-Schnipsel zur Einbindung von CCM19 auslesen

Endpunkt: /hosting/api/client/{clientId}/domain/{domainId}/onboarding/embed

Methode: GET

Query:

- {clientId}: string – Die ID eines CCM19-Kundenkontos - {domainId}: string – Die ID einer Domain, die in dem Kundenkonto vorhanden ist

Response:

- 200 – Erfolg - OnboardingEmbedCodeSnippets - 404 – Ressource nicht gefunden