Onboarding
Visión general
Descripción Método Punto final | ||
---|---|---|
- | Escanear dominio GET /hosting/api/client/{clientId}/domain/{domainId}/onboarding/scan |
|
- | Importar plantillas POST /hosting/api/client/{clientId}/domain/{domainId}/onboarding/presets |
|
-- | Crear incrustaciones a partir de cookies POST /hosting/api/client/{clientId}/domain/{domainId}/onboarding/embeddingsFromCookies |
|
---- | Leer fragmentos de código para incrustar CCM19 GET /hosting/api/client/{clientId}/domain/{domainId}/onboarding/embed |
-## Escanear dominio {#scan domain}
Endpoint:/hosting/api/client/{clientId}/domain/{domainId}/onboarding/scan
Método:GET
Consulta:
{clientId}
: -string - El ID de una cuenta de cliente CCM19{domainId}
: cadena - 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ío404
- Recurso no encontrado500
- Se ha producido un problema al rastrear el sitio web
-## Importar plantillas {#import presets}
Endpoint:/hosting/api/client/{clientId}/domain/{domainId}/onboarding/presets
Método:POST
Consulta:
{clientId}
: -string - El ID de una cuenta de cliente CCM19{domainId}
: cadena - 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 ausentes404
- Recurso no encontrado
--## Crear incrustaciones a partir de cookies {#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}
: cadena - El ID de un dominio que existe en la cuenta de cliente
Carga útil: -OnboardingCookie[]
Respuesta:
201
- Recurso(s) creado(s) con éxito400
- Propiedades no válidas o ausentes404
- Recurso no encontrado
----## Leer fragmentos de código para la integración de CCM19 {#get embed code snippets}
Endpoint:/hosting/api/client/{clientId}/domain/{domainId}/onboarding/embed
Método:GET
Consulta:
{clientId}
: -string - El ID de una cuenta de cliente CCM19{domainId}
: cadena - El ID de un dominio que existe en la cuenta de cliente
Respuesta:
200
- Éxito- ---OnboardingEmbedCodeSnippets
404
- Recurso no encontrado