Zenler (publicador independiente) (versión preliminar)
Zenler es una plataforma de creación, entrega y marketing de cursos integrales.
Este conector está disponible en los siguientes productos y regiones:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Aplicaciones lógicas | Estándar | Todas las regiones de Logic Apps excepto las siguientes: - Regiones de Azure Government - Regiones de Azure China - Departamento de Defensa de EE. UU. (DoD) |
| Power Apps | Premium | Todas las regiones de Power Apps excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Power Automate | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Contacto | |
|---|---|
| Nombre | Troy Taylor |
| URL | https://www.hitachisolutions.com |
| Correo Electrónico | ttaylor@hitachisolutions.com |
| Metadatos del conector | |
|---|---|
| Publicador | Troy Taylor |
| Sitio web | https://www.newzenler.com/ |
| Directiva de privacidad | https://www.newzenler.com/privacy-policy |
| Categorías | Gestión empresarial |
Creación de una conexión
El conector admite los siguientes tipos de autenticación:
| Predeterminado | Parámetros para crear una conexión. | Todas las regiones | No se puede compartir |
Predeterminado
Aplicable: Todas las regiones
Parámetros para crear una conexión.
Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.
| Nombre | Tipo | Description | Obligatorio |
|---|---|---|---|
| Clave de API | securestring | La clave de API de esta API | Cierto |
| Nombre de cuenta | securestring | El nombre de la cuenta de esta API | Cierto |
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 100 | 60 segundos |
Acciones
| Actualizar usuario |
Actualiza la información de un usuario. |
| Agregar usuario |
Crea un nuevo usuario. |
| Anulación de la inscripción de un usuario |
Anula la inscripción de un usuario de un curso. |
| Anulación del registro del seminario web |
Anule el registro de un usuario para un seminario web en directo. |
| Anular el registro de la clase |
Anule el registro de un usuario para una clase activa. |
| Cancelar la suscripción al embudo |
Cancela la suscripción de un usuario de un embudo. |
| Eliminar un usuario |
Quite un usuario de su cuenta. |
| Inscripción de un usuario |
Inscribe un usuario en un curso. |
| Obtención de detalles del usuario |
Recupere información sobre un usuario. |
| Obtención de inscripciones para un embudo |
Recupera una lista de inscripciones para un embudo. |
| Obtención de un informe de ventas breve |
Recupera un breve informe de ventas. |
| Obtención de un informe de ventas detallado |
Recupera un informe de ventas detallado. |
| Obtención de un informe detallado de afiliados |
Recupera un informe detallado de afiliados. |
| Obtención de un informe detallado de progreso del curso |
Recupera un informe detallado del progreso del curso. |
| Obtención del informe de inscripciones breves |
Recupera una breve lista de inscripciones. |
| Obtención del informe de inscripciones detalladas |
Recupera una lista detallada de inscripciones. |
| Obtener breve informe de progreso del curso |
Recupera un breve informe del progreso del curso. |
| Obtener curso |
Recupera un curso por identificador de curso. |
| Obtener embudos |
Recupera una lista de embudos. |
| Obtener la lista de cursos |
Recupera una lista de cursos. |
| Obtener las próximas clases |
Recupera una lista de las próximas clases activas. |
| Obtener lista de usuarios |
Recupera una lista de usuarios. |
| Obtener próximos seminarios web |
Recupere una lista de los próximos seminarios web en directo. |
| Obtener un informe breve de afiliados |
Recupera un breve informe de filiales. |
| Registro para el seminario web |
Registre un usuario para un seminario web en directo. |
| Registro para la clase |
Registre un usuario para una clase activa. |
| Suscribirse al embudo |
Suscríbase un usuario a un embudo. |
Actualizar usuario
Actualiza la información de un usuario.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de usuario
|
user_id | True | string |
Identificador de usuario. |
|
Nombre
|
first_name | True | string |
Nombre. |
|
Apellido
|
last_name | True | string |
Apellidos. |
|
Correo Electrónico
|
True | string |
Dirección de correo electrónico. |
|
|
Contraseña
|
password | True | string |
La contraseña. |
|
Comisiones
|
commission | True | integer |
La comisión. |
|
Funciones
|
roles | True | string |
Los roles. |
|
Dirección
|
address | string |
Dirección. |
|
|
City
|
city | string |
La ciudad. |
|
|
Estado
|
state | string |
El estado. |
|
|
Teléfono
|
phone | string |
Número de teléfono. |
|
|
Código postal
|
zip_code | integer |
El código postal. |
|
|
País
|
country | string |
El país. |
|
|
Estado de consentimiento del RGPD
|
gdpr_consent_status | integer |
El estado de consentimiento del RGPD. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código de respuesta
|
response_code | integer |
Código de respuesta. |
|
Message
|
message | string |
Mensaje de respuesta. |
|
Message
|
data.message | string |
Mensaje. |
Agregar usuario
Crea un nuevo usuario.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre
|
first_name | True | string |
Nombre. |
|
Apellido
|
last_name | True | string |
Apellidos. |
|
Correo Electrónico
|
True | string |
Dirección de correo electrónico. |
|
|
Contraseña
|
password | True | string |
La contraseña. |
|
Comisiones
|
commission | True | integer |
La comisión. |
|
Funciones
|
roles | True | string |
Los roles. |
|
Dirección
|
address | string |
Dirección. |
|
|
City
|
city | string |
La ciudad. |
|
|
Estado
|
state | string |
El estado. |
|
|
Teléfono
|
phone | string |
Número de teléfono. |
|
|
Código postal
|
zip_code | integer |
El código postal. |
|
|
País
|
country | string |
El país. |
|
|
Estado de consentimiento del RGPD
|
gdpr_consent_status | integer |
El estado de consentimiento del RGPD. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código de respuesta
|
response_code | integer |
Código de respuesta. |
|
Message
|
message | string |
Mensaje de respuesta. |
|
identificación
|
data.id | string |
Identificador. |
|
Nombre
|
data.first_name | string |
Nombre. |
|
Apellido
|
data.last_name | string |
Apellidos. |
|
Correo Electrónico
|
data.email | string |
Dirección de correo electrónico. |
Anulación de la inscripción de un usuario
Anula la inscripción de un usuario de un curso.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de usuario
|
user_id | True | string |
Identificador de usuario. |
|
Id. de curso
|
course_id | True | string |
Identificador del curso. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código de respuesta
|
response_code | integer |
Código de respuesta. |
|
Message
|
message | string |
Mensaje de respuesta. |
|
Message
|
data.message | string |
Mensaje. |
Anulación del registro del seminario web
Anule el registro de un usuario para un seminario web en directo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de seminario web
|
webinar_id | True | string |
Identificador del seminario web. |
|
Correo Electrónico
|
True | string |
Dirección de correo electrónico. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código de respuesta
|
response_code | integer |
Código de respuesta. |
|
Message
|
message | string |
Mensaje de respuesta. |
|
Data
|
data | string |
Los datos. |
Anular el registro de la clase
Anule el registro de un usuario para una clase activa.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Live Class ID
|
liveclass_id | True | string |
Identificador de clase activa. |
|
Correo Electrónico
|
string |
El correo electrónico. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código de respuesta
|
response_code | integer |
Código de respuesta. |
|
Message
|
message | string |
Mensaje de respuesta. |
|
Data
|
data | string |
Los datos. |
Cancelar la suscripción al embudo
Cancela la suscripción de un usuario de un embudo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de embudo
|
funnel_id | True | string |
Identificador de embudo. |
|
Correo Electrónico
|
string |
El correo electrónico. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código de respuesta
|
response_code | integer |
Código de respuesta. |
|
Message
|
message | string |
Mensaje de respuesta. |
|
Data
|
data | string |
Los datos. |
Eliminar un usuario
Quite un usuario de su cuenta.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de usuario
|
user_id | True | string |
Identificador de usuario. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código de respuesta
|
response_code | integer |
Código de respuesta. |
|
Message
|
message | string |
Mensaje de respuesta. |
|
Data
|
data | string |
Los datos. |
Inscripción de un usuario
Inscribe un usuario en un curso.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de usuario
|
user_id | True | string |
Identificador de usuario. |
|
Id. de curso
|
course_id | True | string |
Identificador del curso. |
|
Id. de plan
|
plan_id | string |
Identificador del plan. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código de respuesta
|
response_code | integer |
Código de respuesta. |
|
Message
|
message | string |
Mensaje de respuesta. |
|
Data
|
data | string |
Los datos. |
Obtención de detalles del usuario
Recupere información sobre un usuario.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de usuario
|
user_id | True | string |
Identificador de usuario. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código de respuesta
|
response_code | integer |
Código de respuesta. |
|
Message
|
message | string |
Mensaje de respuesta. |
|
identificación
|
data.id | string |
Identificador. |
|
Nombre
|
data.first_name | string |
Nombre. |
|
Apellido
|
data.last_name | string |
Apellidos. |
|
Correo Electrónico
|
data.email | string |
Dirección de correo electrónico. |
|
Biografía
|
data.bio | string |
La biografía. |
|
Dirección
|
data.address | string |
Dirección. |
|
City
|
data.city | string |
La ciudad. |
|
Estado
|
data.state | string |
El estado. |
|
Código postal
|
data.zip_code | string |
El código postal. |
|
Funciones
|
data.roles | array of integer | |
|
Teléfono
|
data.phone | string |
Número de teléfono. |
Obtención de inscripciones para un embudo
Recupera una lista de inscripciones para un embudo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de embudo
|
funnel_id | True | string |
Identificador de embudo. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código de respuesta
|
response_code | integer |
Código de respuesta. |
|
Message
|
message | string |
Mensaje de respuesta. |
|
Productos
|
data.items | array of object | |
|
identificación
|
data.items.id | string |
Identificador. |
|
Nombre
|
data.items.first_name | string |
Nombre. |
|
Apellido
|
data.items.last_name | string |
Apellidos. |
|
Correo Electrónico
|
data.items.email | string |
Dirección de correo electrónico. |
|
Inscrito en
|
data.items.enrolled_on | string |
Cuando se inscribe. |
Obtención de un informe de ventas breve
Recupera un breve informe de ventas.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Fecha de inicio
|
start_date | string |
Fecha de inicio. |
|
|
Fecha de finalización
|
end_date | string |
Fecha de finalización. |
|
|
Limit
|
limit | integer |
El límite. |
|
|
Página
|
page | integer |
Número de página. |
|
|
Agrupar por
|
groupby | string |
Grupo por. |
|
|
Identificadores de curso
|
course_ids | string |
Identificadores del curso. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código de respuesta
|
response_code | integer |
Código de respuesta. |
|
Message
|
message | string |
Mensaje de respuesta. |
|
Productos
|
data.items | array of object | |
|
Ventas totales
|
data.items.total_sales | integer |
Ventas totales. |
|
Id. de curso
|
data.items.course_id | integer |
Identificador del curso. |
|
Total de ganancias
|
data.items.earnings_total | string |
Total de ganancias. |
|
Total de ventas
|
data.items.sales_total | string |
Total de ventas. |
|
Cuota de aff
|
data.items.aff_fee | string |
La cuota de filial. |
|
Nombre
|
data.items.name | string |
Nombre. |
|
Day
|
data.items.day | string |
Día. |
|
Mes
|
data.items.month | string |
El mes. |
|
Moneda
|
data.items.currency | string |
Moneda. |
|
Total de elementos
|
data.pagination.total_items | integer |
Número total de elementos. |
|
Elementos por página
|
data.pagination.items_per_page | integer |
Elementos por página. |
|
Índice de página
|
data.pagination.page_index | integer |
Índice de página. |
|
Total de páginas
|
data.pagination.total_pages | integer |
Número total de páginas. |
Obtención de un informe de ventas detallado
Recupera un informe de ventas detallado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Fecha de inicio
|
start_date | string |
Fecha de inicio. |
|
|
Fecha de finalización
|
end_date | string |
Fecha de finalización. |
|
|
Limit
|
limit | integer |
El límite. |
|
|
Página
|
page | integer |
Número de página. |
|
|
Identificadores de curso
|
course_ids | string |
Identificadores del curso. |
|
|
Tipo de pago
|
payment_type | integer |
Tipo de pago. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código de respuesta
|
response_code | integer |
Código de respuesta. |
|
Message
|
message | string |
Mensaje de respuesta. |
|
Productos
|
data.items | array of object | |
|
Creado en
|
data.items.created_at | string |
Cuando se crea en . |
|
Id. de transacción
|
data.items.transaction_id | string |
Identificador de transacción. |
|
Precio de venta
|
data.items.sales_price | string |
Precio de venta. |
|
Ganar precio
|
data.items.earn_price | string |
El precio de ganar. |
|
Nombre del alumno
|
data.items.student_name | string |
Nombre del alumno. |
|
Correo electrónico de alumno
|
data.items.student_email | string |
Dirección de correo electrónico del alumno. |
|
Curso
|
data.items.course | string |
El curso. |
|
Id. de curso
|
data.items.course_id | integer |
Identificador del curso. |
|
Código de cupón
|
data.items.coupon_code | string |
El código de vale. |
|
Puerta de enlace de pago
|
data.items.payment_gateway | string |
La puerta de enlace de pago. |
|
Total de elementos
|
data.pagination.total_items | integer |
Número total de elementos. |
|
Elementos por página
|
data.pagination.items_per_page | integer |
Elementos por página. |
|
Índice de página
|
data.pagination.page_index | integer |
Índice de página. |
|
Total de páginas
|
data.pagination.total_pages | integer |
Número total de páginas. |
Obtención de un informe detallado de afiliados
Recupera un informe detallado de afiliados.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Fecha de inicio
|
start_date | string |
Fecha de inicio. |
|
|
Fecha de finalización
|
end_date | string |
Fecha de finalización. |
|
|
Limit
|
limit | integer |
El límite. |
|
|
Página
|
page | integer |
Número de página. |
|
|
Identificadores de curso
|
course_ids[] | string |
Identificadores del curso. |
|
|
Identificadores de filial
|
affiliate_ids[] | string |
Identificadores de filial. |
|
|
Filtro avanzado
|
af_v | string |
Filtro avanzado. |
|
|
El cupón es
|
coupon_is[] | string |
El cupón es. |
|
|
Cupón como
|
coupon_like[] | string |
El cupón es como. |
|
|
Nombre es
|
name_is[] | string |
El nombre es. |
|
|
Nombre como
|
name_like[] | string |
El nombre es como. |
|
|
El correo electrónico es
|
email_is[] | string |
El correo electrónico es. |
|
|
Correo electrónico como
|
email_like[] | string |
El correo electrónico es similar. |
|
|
Filial es
|
affiliate_is[] | string |
El afiliado es. |
|
|
Tipo de pago
|
payment_type | string |
Tipo de pago. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código de respuesta
|
response_code | integer |
Código de respuesta. |
|
Message
|
message | string |
Mensaje de respuesta. |
|
Productos
|
data.items | array of object | |
|
Curso
|
data.items.course | string |
El curso. |
|
Creado en
|
data.items.created_at | string |
Cuando se crea en . |
|
Precio de venta
|
data.items.sales_price | string |
Precio de venta. |
|
Descuento de cupones
|
data.items.coupon_discount | string |
Descuento del cupón. |
|
Comisiones
|
data.items.commission | string |
La comisión. |
|
Estado de pago
|
data.items.payout_status | string |
Estado del pago. |
|
Total de elementos
|
data.pagination.total_items | integer |
Número total de elementos. |
|
Elementos por página
|
data.pagination.items_per_page | integer |
Elementos por página. |
|
Índice de página
|
data.pagination.page_index | integer |
Índice de página. |
|
Total de páginas
|
data.pagination.total_pages | integer |
Número total de páginas. |
Obtención de un informe detallado de progreso del curso
Recupera un informe detallado del progreso del curso.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Fecha de inicio
|
start_date | string |
Fecha de inicio. |
|
|
Fecha de finalización
|
end_date | string |
Fecha de finalización. |
|
|
Limit
|
limit | integer |
El límite. |
|
|
Página
|
page | integer |
Número de página. |
|
|
Identificadores de curso
|
course_ids[] | string |
Identificadores del curso. |
|
|
Filtro avanzado
|
af_v | string |
Filtro avanzado. |
|
|
El cupón es
|
coupon_is[] | string |
El cupón es. |
|
|
Cupón como
|
coupon_like[] | string |
El cupón es como. |
|
|
Nombre es
|
name_is[] | string |
El nombre es. |
|
|
Nombre como
|
name_like[] | string |
El nombre es como. |
|
|
El correo electrónico es
|
email_is[] | string |
El correo electrónico es. |
|
|
Correo electrónico como
|
email_like[] | string |
El correo electrónico es similar. |
|
|
Filial es
|
affiliate_is[] | string |
El afiliado es. |
|
|
Tipo de pago
|
payment_type | integer |
Tipo de pago. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código de respuesta
|
response_code | integer |
Código de respuesta. |
|
Message
|
message | string |
Mensaje de respuesta. |
|
UID
|
data.items.course_number.uid | string |
Identificador único. |
|
Id. de curso
|
data.items.course_number.courseId | string |
Identificador del curso. |
|
Nombre
|
data.items.course_number.name | string |
Nombre. |
|
Correo Electrónico
|
data.items.course_number.email | string |
Dirección de correo electrónico. |
|
Fecha de inscripción
|
data.items.course_number.enrollment_date | string |
Fecha de inscripción. |
|
Fecha de inicio
|
data.items.course_number.start_date | string |
Fecha de inicio. |
|
Fecha de finalización
|
data.items.course_number.completed_date | string |
Fecha de finalización. |
|
Estado
|
data.items.course_number.status | string |
Estado. |
|
Última asistencia
|
data.items.course_number.last_attended | string |
Cuando asistió por última vez. |
|
Porcentaje de finalización
|
data.items.course_number.completion_percentage | integer |
Porcentaje de finalización. |
|
Total de elementos
|
data.pagination.total_items | integer |
Número total de elementos. |
|
Elementos por página
|
data.pagination.items_per_page | string |
Elementos por página. |
|
Índice de página
|
data.pagination.page_index | string |
Índice de página. |
|
Total de páginas
|
data.pagination.total_pages | integer |
Número total de páginas. |
Obtención del informe de inscripciones breves
Recupera una breve lista de inscripciones.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Fecha de inicio
|
start_date | string |
Fecha de inicio. |
|
|
Fecha de finalización
|
end_date | string |
Fecha de finalización. |
|
|
Id. de curso
|
course_id | string |
Identificador del curso. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código de respuesta
|
response_code | integer |
Código de respuesta. |
|
Message
|
message | string |
Mensaje de respuesta. |
|
Productos
|
data.items | array of object | |
|
Id. de curso
|
data.items.course_id | integer |
Identificador del curso. |
|
Nombre del curso
|
data.items.course_name | string |
Nombre del curso. |
|
Número de inscripciones
|
data.items.no_of_enrollments | integer |
Número de inscripciones. |
|
Total de elementos
|
data.pagination.total_items | integer |
Número total de elementos. |
|
Elementos por página
|
data.pagination.items_per_page | integer |
Elementos por página. |
|
Índice de página
|
data.pagination.page_index | integer |
Índice de página. |
|
Total de páginas
|
data.pagination.total_pages | integer |
Número total de páginas. |
Obtención del informe de inscripciones detalladas
Recupera una lista detallada de inscripciones.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Fecha de inicio
|
start_date | string |
Fecha de inicio. |
|
|
Fecha de finalización
|
end_date | string |
Fecha de finalización. |
|
|
Id. de curso
|
course_id | string |
Identificador del curso. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código de respuesta
|
response_code | integer |
Código de respuesta. |
|
Message
|
message | string |
Mensaje de respuesta. |
|
Productos
|
data.items | array of object | |
|
Id. de curso
|
data.items.course_id | integer |
Identificador del curso. |
|
Id. de usuario
|
data.items.user_id | string |
Identificador de usuario. |
|
Nombre del curso
|
data.items.course_name | string |
Nombre del curso. |
|
Nombre
|
data.items.first_name | string |
Nombre. |
|
Apellido
|
data.items.last_name | string |
Apellidos. |
|
Correo Electrónico
|
data.items.email | string |
Dirección de correo electrónico. |
|
Fecha de inscripción
|
data.items.enrollment_date | string |
Fecha de inscripción. |
Obtener breve informe de progreso del curso
Recupera un breve informe del progreso del curso.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Fecha de inicio
|
start_date | string |
Fecha de inicio. |
|
|
Fecha de finalización
|
end_date | string |
Fecha de finalización. |
|
|
Limit
|
limit | integer |
El límite. |
|
|
Página
|
page | integer |
Número de página. |
|
|
Identificadores de curso
|
course_ids[] | string |
Identificadores del curso. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código de respuesta
|
response_code | integer |
Código de respuesta. |
|
Message
|
message | string |
Mensaje de respuesta. |
|
Id. de curso
|
data.items.course_number.courseId | integer |
Identificador del curso. |
|
Fecha de inicio
|
data.items.course_number.start_date | string |
Fecha de inicio. |
|
Última fecha
|
data.items.course_number.last_date | string |
La última fecha. |
|
Nombre del curso
|
data.items.course_number.courseName | string |
Nombre del curso. |
|
Total de estudiantes
|
data.items.course_number.total_students | integer |
Número total de alumnos. |
|
No iniciado
|
data.items.course_number.not_started | integer |
Indica si se ha iniciado. |
|
En curso
|
data.items.course_number.in_progress | integer |
Si está en curso. |
|
Completado
|
data.items.course_number.completed | integer |
Indica si se ha completado. |
|
Tasa de pases
|
data.items.course_number.pass_rate | integer |
Tasa de pases. |
|
Total de elementos
|
data.pagination.total_items | integer |
Número total de elementos. |
|
Elementos por página
|
data.pagination.items_per_page | string |
Elementos por página. |
|
Índice de página
|
data.pagination.page_index | string |
Índice de página. |
|
Total de páginas
|
data.pagination.total_pages | integer |
Número total de páginas. |
Obtener curso
Recupera un curso por identificador de curso.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de curso
|
course_id | True | string |
Identificador del curso. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código de respuesta
|
response_code | integer |
Código de respuesta. |
|
Message
|
message | string |
Mensaje de respuesta. |
|
identificación
|
data.items.id | integer |
Identificador. |
|
Nombre
|
data.items.name | string |
Nombre. |
|
Subtítulo
|
data.items.subtitle | string |
El subtítulo. |
|
Miniatura
|
data.items.thumbnail | string |
Miniatura. |
|
Tipo de curso
|
data.items.course_type | integer |
Tipo de curso. |
|
Propietario
|
data.items.owner | string |
El propietario. |
|
Id. de escuela
|
data.items.school_id | integer |
Identificador de la escuela. |
|
Público
|
data.items.public | integer |
Si es público. |
|
Recomendados
|
data.items.featured | integer |
Indica si se ha destacado . |
|
Oculto
|
data.items.hidden | integer |
Si está oculto. |
|
Privada
|
data.items.private | integer |
Si es privado. |
Obtener embudos
Recupera una lista de embudos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
El límite. |
|
|
Página
|
page | integer |
Número de página. |
|
|
Ordenar por
|
orderby | string |
Orden por campo. |
|
|
Pedido
|
order | string |
Orden. |
|
|
Search
|
search | string |
Término de búsqueda. |
|
|
Estado
|
status | integer |
Estado. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código de respuesta
|
response_code | integer |
Código de respuesta. |
|
Message
|
message | string |
Mensaje de respuesta. |
|
Productos
|
data.items | array of object | |
|
identificación
|
data.items.id | integer |
Identificador. |
|
Nombre
|
data.items.name | string |
Nombre. |
|
Tipo
|
data.items.type | string |
Tipo. |
|
URL
|
data.items.url | string |
Dirección URL. |
|
Total de clientes potenciales
|
data.items.total_leads | integer |
Número total de clientes potenciales. |
|
Miniatura
|
data.items.thumbnail | string |
Miniatura. |
|
Total de elementos
|
data.pagination.total_items | integer |
Número total de elementos. |
|
Elementos por página
|
data.pagination.items_per_page | integer |
Elementos por página. |
|
Índice de página
|
data.pagination.page_index | integer |
Índice de página. |
|
Total de páginas
|
data.pagination.total_pages | integer |
Número total de páginas. |
Obtener la lista de cursos
Recupera una lista de cursos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
El límite. |
|
|
Página
|
page | integer |
Número de página. |
|
|
Ordenar por
|
orderby | string |
Orden por campo. |
|
|
Pedido
|
order | string |
Orden. |
|
|
Search
|
search | string |
Término de búsqueda. |
|
|
Tipo
|
type | integer |
Tipo. |
|
|
Estado
|
status | integer |
Estado. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código de respuesta
|
response_code | integer |
Código de respuesta. |
|
Message
|
message | string |
Mensaje de respuesta. |
|
Productos
|
data.items | array of object | |
|
identificación
|
data.items.id | integer |
Identificador. |
|
Nombre
|
data.items.name | string |
Nombre. |
|
Subtítulo
|
data.items.subtitle | string |
El subtítulo. |
|
Miniatura
|
data.items.thumbnail | string |
Miniatura. |
|
URL
|
data.items.url | string |
Dirección URL. |
|
Total de elementos
|
data.pagination.total_items | integer |
Número total de elementos. |
|
Elementos por página
|
data.pagination.items_per_page | integer |
Elementos por página. |
|
Índice de página
|
data.pagination.page_index | integer |
Índice de página. |
|
Total de páginas
|
data.pagination.total_pages | integer |
Número total de páginas. |
Obtener las próximas clases
Recupera una lista de las próximas clases activas.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
El límite. |
|
|
Página
|
page | integer |
Número de página. |
|
|
Ordenar por
|
orderby | string |
Orden por campo. |
|
|
Pedido
|
order | string |
Orden. |
|
|
Search
|
search | string |
Término de búsqueda. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código de respuesta
|
response_code | integer |
Código de respuesta. |
|
Message
|
message | string |
Mensaje de respuesta. |
|
Productos
|
data.items | array of object | |
|
identificación
|
data.items.id | integer |
Identificador. |
|
Tema
|
data.items.topic | string |
El tema. |
|
Fecha de programación
|
data.items.schedule_date | string |
Fecha de programación. |
|
Timezone
|
data.items.timezone | string |
La zona horaria. |
|
Duración
|
data.items.duration | integer |
Duración. |
|
Dirección URL de registro
|
data.items.register_url | string |
Dirección URL del registro. |
|
Periódico
|
data.items.recurring | boolean |
Si es periódico. |
|
Programación periódica reciente
|
data.items.recent_recurring_schedule | string |
La programación periódica reciente. |
|
Total de elementos
|
data.pagination.total_items | integer |
Número total de elementos. |
|
Elementos por página
|
data.pagination.items_per_page | integer |
Elementos por página. |
|
Índice de página
|
data.pagination.page_index | integer |
Índice de página. |
|
Total de páginas
|
data.pagination.total_pages | integer |
Número total de páginas. |
Obtener lista de usuarios
Recupera una lista de usuarios.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
El límite. |
|
|
Página
|
page | integer |
Número de página. |
|
|
Ordenar por
|
orderby | string |
Orden por campo. |
|
|
Pedido
|
order | string |
Orden. |
|
|
Search
|
search | string |
Término de búsqueda. |
|
|
Rol
|
role | integer |
Rol. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código de respuesta
|
response_code | integer |
Código de respuesta. |
|
Message
|
message | string |
Mensaje de respuesta. |
|
Productos
|
data.items | array of object | |
|
identificación
|
data.items.id | string |
Identificador. |
|
Nombre
|
data.items.first_name | string |
Nombre. |
|
Apellido
|
data.items.last_name | string |
Apellidos. |
|
Correo Electrónico
|
data.items.email | string |
Dirección de correo electrónico. |
|
Funciones
|
data.items.roles | array of integer |
Los roles. |
|
Total de elementos
|
data.pagination.total_items | integer |
Número total de elementos. |
|
Elementos por página
|
data.pagination.items_per_page | integer |
Elementos por página. |
|
Índice de página
|
data.pagination.page_index | integer |
Índice de página. |
|
Total de páginas
|
data.pagination.total_pages | integer |
Número total de páginas. |
Obtener próximos seminarios web
Recupere una lista de los próximos seminarios web en directo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
El límite. |
|
|
Página
|
page | integer |
Número de página. |
|
|
Ordenar por
|
orderby | string |
Orden por campo. |
|
|
Pedido
|
order | string |
Orden. |
|
|
Search
|
search | string |
Término de búsqueda. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código de respuesta
|
response_code | integer |
Código de respuesta. |
|
Message
|
message | string |
Mensaje de respuesta. |
|
Productos
|
data.items | array of object | |
|
identificación
|
data.items.id | integer |
Identificador. |
|
Tema
|
data.items.topic | string |
El tema. |
|
Fecha de programación
|
data.items.schedule_date | string |
Fecha de programación. |
|
Timezone
|
data.items.timezone | string |
La zona horaria. |
|
Duración
|
data.items.duration | integer |
Duración. |
|
Dirección URL de registro
|
data.items.register_url | string |
Dirección URL del registro. |
|
Periódico
|
data.items.recurring | boolean |
Si es periódico. |
|
Programación periódica reciente
|
data.items.recent_recurring_schedule | string |
La programación periódica reciente. |
|
Total de elementos
|
data.pagination.total_items | integer |
Número total de elementos. |
|
Elementos por página
|
data.pagination.items_per_page | integer |
Elementos por página. |
|
Índice de página
|
data.pagination.page_index | integer |
Índice de página. |
|
Total de páginas
|
data.pagination.total_pages | integer |
Número total de páginas. |
Obtener un informe breve de afiliados
Recupera un breve informe de filiales.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Fecha de inicio
|
start_date | string |
Fecha de inicio. |
|
|
Fecha de finalización
|
end_date | string |
Fecha de finalización. |
|
|
Limit
|
limit | integer |
El límite. |
|
|
Página
|
page | integer |
Número de página. |
|
|
Identificadores de curso
|
course_ids[] | string |
Identificadores del curso. |
|
|
Identificadores de filial
|
affiliate_ids[] | string |
Identificadores de filial. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código de respuesta
|
response_code | integer |
Código de respuesta. |
|
Message
|
message | string |
Mensaje de respuesta. |
|
Productos
|
data.items | array of object | |
|
Moneda
|
data.items.currency | string |
Moneda. |
|
Identificador de aff
|
data.items.aff_id | string |
Identificador de filial. |
|
Nombre de Aff
|
data.items.aff_name | string |
Nombre de filial. |
|
Correo electrónico de Aff
|
data.items.aff_email | string |
Dirección de correo electrónico del afiliado. |
|
Recuento total de ventas
|
data.items.total_sales_count | integer |
Recuento total de ventas. |
|
Total de la Comisión
|
data.items.total_commission | string |
La comisión total. |
|
Comisión pendiente
|
data.items.pending_commission | string |
La comisión pendiente. |
|
Comisión pagada
|
data.items.paid_commission | string |
La comisión pagada. |
|
Total de elementos
|
data.pagination.total_items | integer |
Número total de elementos. |
|
Elementos por página
|
data.pagination.items_per_page | string |
Elementos por página. |
|
Índice de página
|
data.pagination.page_index | string |
Índice de página. |
|
Total de páginas
|
data.pagination.total_pages | integer |
Número total de páginas. |
Registro para el seminario web
Registre un usuario para un seminario web en directo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de seminario web
|
webinar_id | True | string |
Identificador del seminario web. |
|
Nombre
|
name | True | string |
Nombre. |
|
Correo Electrónico
|
True | string |
Dirección de correo electrónico. |
|
|
Apellido
|
last_name | string |
Apellidos. |
|
|
Dirección
|
address | string |
Dirección. |
|
|
City
|
city | string |
La ciudad. |
|
|
Estado
|
state | string |
El estado. |
|
|
Teléfono
|
phone | string |
Número de teléfono. |
|
|
Código postal
|
zip_code | integer |
El código postal. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código de respuesta
|
response_code | integer |
Código de respuesta. |
|
Message
|
message | string |
Mensaje de respuesta. |
|
Nombre
|
data.name | string |
Nombre. |
|
Correo Electrónico
|
data.email | string |
Dirección de correo electrónico. |
|
Seminario web en directo
|
data.live webinar | string |
El seminario web en directo. |
|
Message
|
data.message | string |
Mensaje. |
Registro para la clase
Registre un usuario para una clase activa.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Live Class ID
|
liveclass_id | True | string |
Identificador de clase activa. |
|
Nombre
|
name | True | string |
Nombre. |
|
Correo Electrónico
|
True | string |
Dirección de correo electrónico. |
|
|
Apellido
|
last_name | string |
Apellidos. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código de respuesta
|
response_code | integer |
Código de respuesta. |
|
Message
|
message | string |
Mensaje de respuesta. |
|
Nombre
|
data.name | string |
Nombre. |
|
Correo Electrónico
|
data.email | string |
Dirección de correo electrónico. |
|
Live Class
|
data.live class | string |
Clase activa. |
|
Message
|
data.message | string |
Mensaje. |
Suscribirse al embudo
Suscríbase un usuario a un embudo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de embudo
|
funnel_id | True | string |
Identificador de embudo. |
|
Nombre
|
name | True | string |
Nombre. |
|
Correo Electrónico
|
True | string |
Dirección de correo electrónico. |
|
|
Apellido
|
last_name | string |
Apellidos. |
|
|
Dirección
|
address | string |
Dirección. |
|
|
City
|
city | string |
La ciudad. |
|
|
Estado
|
state | string |
El estado. |
|
|
Teléfono
|
phone | string |
Número de teléfono. |
|
|
Código postal
|
zip_code | integer |
El código postal. |
|
|
País
|
country | string |
El país. |
|
|
Estado de consentimiento del RGPD
|
gdpr_consent_status | integer |
El estado de consentimiento del RGPD. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código de respuesta
|
response_code | integer |
Código de respuesta. |
|
Message
|
message | string |
Mensaje de respuesta. |
|
Nombre
|
data.name | string |
Nombre. |
|
Correo Electrónico
|
data.email | string |
Dirección de correo electrónico. |
|
Embudo
|
data.funnel | string |
Embudo. |