Zum Inhalt

Onboarding

Visión general

| Descripción | Método | Punto final | | ---------------------------------------------------------------------------- | ------- | ----------------------------------------------------------------------------------- | | Escanear dominio | GET <nt>|</nt>/hosting/api/client/{clientId}/domain/{domainId}/onboarding/scan<nt>|</nt> <nt>|</nt> [Importar plantillas](#import-presets) <nt>|</nt>POST | alojamiento/api/cliente/{clientId}/dominio/{domainId}/onboarding/presets | | Crear incrustaciones a partir de cookies | POST <nt>|</nt>/hosting/api/client/{clientId}/domain/{domainId}/onboarding/embeddingsFromCookies` | | Leer fragmentos de código para incrustar CCM19 | oBTENER | /hosting/api/client/{clientId}/domain/{domainId}/onboarding/embed" |

Escanear dominio

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

Método:GET

Consulta:

  • {clientId}: string - El ID de una cuenta de cliente CCM19
  • {domainId}: string - El ID de un dominio que existe en la cuenta de cliente

Respuesta:

  • 200 - Éxito
  • OnboardingScanResult
  • 400 - El sitio web ha enviado un código de respuesta incorrecto o contenido vacío
  • 404 - Recurso no encontrado
  • 500 - Se ha producido un problema al rastrear el sitio web

Importar plantillas

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

Método:POST

Consulta:

  • {clientId}: string - El ID de una cuenta de cliente CCM19
  • {domainId}: string - El ID de un dominio que existe en la cuenta de cliente

Carga útil: OnboardingPreset[]

Respuesta:

  • 201 - Recurso creado con éxito
  • OnboardingPresetResult[]
  • 400 - Propiedades no válidas o ausentes
  • 404 - Recurso no encontrado

Crear incrustaciones a partir de cookies

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

Método:POST

Consulta:

  • {clientId}: string - El ID de una cuenta de cliente CCM19
  • {domainId}: string - El ID de un dominio que existe en la cuenta de cliente

Carga útil: OnboardingCookie[]

Respuesta:

  • 201 - Recurso(s) creado(s) con éxito
  • 400 - Propiedades no válidas o ausentes
  • 404 - Recurso no encontrado

Leer fragmentos de código para la integración de CCM19

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

Método:GET

Consulta:

  • {clientId}: string - El ID de una cuenta de cliente CCM19
  • {domainId}: string - El ID de un dominio que existe en la cuenta de cliente

Respuesta: