Zum Inhalt

Onboarding

Overview

Description Method Endpoint
Scan domain GET /hosting/api/client/{clientId}/domain/{domainId}/onboarding/scan
Import templates POST /hosting/api/client/{clientId}/domain/{domainId}/onboarding/presets
Create embeddings from cookies POST /hosting/api/client/{clientId}/domain/{domainId}/onboarding/embeddingsFromCookies
Read code snippets for the integration of CCM19 GET /hosting/api/client/{clientId}/domain/{domainId}/onboarding/embed

Scan domain

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

Method:GET

Query:

  • {clientId}: string - The ID of a CCM19 client account
  • {domainId}: string - The ID of a domain that exists in the client account

Response:

  • 200 - Success
  • OnboardingScanResult
  • 400 - The website has sent an incorrect response code or empty content
  • 404 - Resource not found
  • 500 - A problem occurred while crawling the website

Import templates

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

Method:POST

Query:

  • {clientId}: string - The ID of a CCM19 client account
  • {domainId}: string - The ID of a domain that exists in the client account

Payload:OnboardingPreset[]

Response:

  • 201 - Resource successfully created
  • OnboardingPresetResult[]
  • 400 - Invalid or missing properties
  • 404 - Resource not found

Create embeddings from cookies

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

Method:POST

Query:

  • {clientId}: string - The ID of a CCM19 client account
  • {domainId}: string - The ID of a domain that exists in the client account

Payload:OnboardingCookie[]

Response:

  • 201 - Resource(s) successfully created
  • 400 - Invalid or missing properties
  • 404 - Resource not found

Read code snippets for the integration of CCM19

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

Method:GET

Query:

  • {clientId}: string - The ID of a CCM19 client account
  • {domainId}: string - The ID of a domain that exists in the client account

Response: