Zenler (Editor Independente) (versão prévia)
O Zenler é uma plataforma de criação, entrega e marketing do curso all-in-one.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Troy Taylor |
| URL | https://www.hitachisolutions.com |
| ttaylor@hitachisolutions.com |
| Metadados do conector | |
|---|---|
| Publicador | Troy Taylor |
| Site | https://www.newzenler.com/ |
| Política de privacidade | https://www.newzenler.com/privacy-policy |
| Categorias | Gestão de empresas |
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: todas as regiões
Parâmetros para criar conexão.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Chave de API | secureString | A chave de API para esta api | Verdade |
| Nome da Conta | secureString | O nome da conta para esta api | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Adicionar usuário |
Cria um novo usuário. |
| Assinar o funil |
Assine um usuário em um funil. |
| Atualizar usuário |
Atualiza as informações de um usuário. |
| Cancelar a assinatura do funil |
Cancela a assinatura de um usuário de um funil. |
| Cancelar o registro da classe |
Cancelar o registro de um usuário para uma classe dinâmica. |
| Cancelar o registro de um usuário |
Cancela o registro de um usuário de um curso. |
| Cancelar o registro para webinar |
Cancelar o registro de um usuário para um webinar dinâmico. |
| Excluir um usuário |
Remova um usuário da sua conta. |
| Obter breve relatório de afiliadas |
Recupera um breve relatório de afiliadas. |
| Obter breve relatório de vendas |
Recupera um breve relatório de vendas. |
| Obter classes futuras |
Recupera uma lista das próximas classes ao vivo. |
| Obter curso |
Recupera um curso por identificador de curso. |
| Obter detalhes do usuário |
Recupere informações sobre um usuário. |
| Obter funis |
Recupera uma lista de funis. |
| Obter lista de cursos |
Recupera uma lista de cursos. |
| Obter lista de usuários |
Recupera uma lista de usuários. |
| Obter registros para um funil |
Recupera uma lista de registros para um funil. |
| Obter um breve relatório de progresso do curso |
Recupera um breve relatório do progresso do curso. |
| Obter um relatório de registros breves |
Recupera uma breve lista de registros. |
| Obter um relatório de vendas detalhado |
Recupera um relatório de vendas detalhado. |
| Obter um relatório detalhado de afiliadas |
Recupera um relatório detalhado de afiliadas. |
| Obter um relatório detalhado de progresso do curso |
Recupera um relatório detalhado do progresso do curso. |
| Obter um relatório detalhado de registros |
Recupera uma lista detalhada de registros. |
| Obter webinars futuros |
Recupere uma lista de webinars ao vivo futuros. |
| Registrar-se para a classe |
Registre um usuário para uma classe dinâmica. |
| Registrar-se para webinar |
Registre um usuário para um webinar dinâmico. |
| Registrar um usuário |
Registra um usuário em um curso. |
Adicionar usuário
Cria um novo usuário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Primeiro Nome
|
first_name | True | string |
O nome. |
|
Apelido
|
last_name | True | string |
O sobrenome. |
|
Email
|
True | string |
O endereço de email. |
|
|
Senha
|
password | True | string |
A senha. |
|
Comissão
|
commission | True | integer |
A comissão. |
|
Funções
|
roles | True | string |
As funções. |
|
Endereço
|
address | string |
O endereço. |
|
|
City
|
city | string |
A cidade. |
|
|
Estado
|
state | string |
O estado. |
|
|
Telefone
|
phone | string |
O número de telefone. |
|
|
Código Postal
|
zip_code | integer |
O cep. |
|
|
País
|
country | string |
O país. |
|
|
Status de consentimento do RGPD
|
gdpr_consent_status | integer |
O status de consentimento do GDPR. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Resposta
|
response_code | integer |
O código de resposta. |
|
Message
|
message | string |
A mensagem de resposta. |
|
ID
|
data.id | string |
O identificador. |
|
Primeiro Nome
|
data.first_name | string |
O nome. |
|
Apelido
|
data.last_name | string |
O sobrenome. |
|
Email
|
data.email | string |
O endereço de email. |
Assinar o funil
Assine um usuário em um funil.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do funil
|
funnel_id | True | string |
O identificador de funil. |
|
Nome
|
name | True | string |
O nome. |
|
Email
|
True | string |
O endereço de email. |
|
|
Apelido
|
last_name | string |
O sobrenome. |
|
|
Endereço
|
address | string |
O endereço. |
|
|
City
|
city | string |
A cidade. |
|
|
Estado
|
state | string |
O estado. |
|
|
Telefone
|
phone | string |
O número de telefone. |
|
|
Código Postal
|
zip_code | integer |
O cep. |
|
|
País
|
country | string |
O país. |
|
|
Status de consentimento do RGPD
|
gdpr_consent_status | integer |
O status de consentimento do GDPR. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Resposta
|
response_code | integer |
O código de resposta. |
|
Message
|
message | string |
A mensagem de resposta. |
|
Nome
|
data.name | string |
O nome. |
|
Email
|
data.email | string |
O endereço de email. |
|
Funil
|
data.funnel | string |
O funil. |
Atualizar usuário
Atualiza as informações de um usuário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
user_id | True | string |
O identificador do usuário. |
|
Primeiro Nome
|
first_name | True | string |
O nome. |
|
Apelido
|
last_name | True | string |
O sobrenome. |
|
Email
|
True | string |
O endereço de email. |
|
|
Senha
|
password | True | string |
A senha. |
|
Comissão
|
commission | True | integer |
A comissão. |
|
Funções
|
roles | True | string |
As funções. |
|
Endereço
|
address | string |
O endereço. |
|
|
City
|
city | string |
A cidade. |
|
|
Estado
|
state | string |
O estado. |
|
|
Telefone
|
phone | string |
O número de telefone. |
|
|
Código Postal
|
zip_code | integer |
O cep. |
|
|
País
|
country | string |
O país. |
|
|
Status de consentimento do RGPD
|
gdpr_consent_status | integer |
O status de consentimento do GDPR. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Resposta
|
response_code | integer |
O código de resposta. |
|
Message
|
message | string |
A mensagem de resposta. |
|
Message
|
data.message | string |
A mensagem. |
Cancelar a assinatura do funil
Cancela a assinatura de um usuário de um funil.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do funil
|
funnel_id | True | string |
O identificador de funil. |
|
Email
|
string |
O email. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Resposta
|
response_code | integer |
O código de resposta. |
|
Message
|
message | string |
A mensagem de resposta. |
|
Dados
|
data | string |
Os dados. |
Cancelar o registro da classe
Cancelar o registro de um usuário para uma classe dinâmica.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da classe ao vivo
|
liveclass_id | True | string |
O identificador de classe dinâmica. |
|
Email
|
string |
O email. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Resposta
|
response_code | integer |
O código de resposta. |
|
Message
|
message | string |
A mensagem de resposta. |
|
Dados
|
data | string |
Os dados. |
Cancelar o registro de um usuário
Cancela o registro de um usuário de um curso.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
user_id | True | string |
O identificador do usuário. |
|
ID do Curso
|
course_id | True | string |
O identificador do curso. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Resposta
|
response_code | integer |
O código de resposta. |
|
Message
|
message | string |
A mensagem de resposta. |
|
Message
|
data.message | string |
A mensagem. |
Cancelar o registro para webinar
Cancelar o registro de um usuário para um webinar dinâmico.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Webinar ID
|
webinar_id | True | string |
O identificador webinar. |
|
Email
|
True | string |
O endereço de email. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Resposta
|
response_code | integer |
O código de resposta. |
|
Message
|
message | string |
A mensagem de resposta. |
|
Dados
|
data | string |
Os dados. |
Excluir um usuário
Remova um usuário da sua conta.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
user_id | True | string |
O identificador do usuário. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Resposta
|
response_code | integer |
O código de resposta. |
|
Message
|
message | string |
A mensagem de resposta. |
|
Dados
|
data | string |
Os dados. |
Obter breve relatório de afiliadas
Recupera um breve relatório de afiliadas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Data de Início
|
start_date | string |
A data de início. |
|
|
Data de Término
|
end_date | string |
A data de término. |
|
|
Limit
|
limit | integer |
O limite. |
|
|
Página
|
page | integer |
O número da página. |
|
|
IDs do curso
|
course_ids[] | string |
Os identificadores do curso. |
|
|
IDs de afiliadas
|
affiliate_ids[] | string |
Os identificadores de afiliada. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Resposta
|
response_code | integer |
O código de resposta. |
|
Message
|
message | string |
A mensagem de resposta. |
|
Itens
|
data.items | array of object | |
|
Moeda
|
data.items.currency | string |
A moeda. |
|
Aff ID
|
data.items.aff_id | string |
O identificador de afiliada. |
|
Nome do Aff
|
data.items.aff_name | string |
O nome da afiliada. |
|
Aff Email
|
data.items.aff_email | string |
O endereço de email da afiliada. |
|
Contagem total de vendas
|
data.items.total_sales_count | integer |
A contagem total de vendas. |
|
Comissão Total
|
data.items.total_commission | string |
A comissão total. |
|
Comissão pendente
|
data.items.pending_commission | string |
A comissão pendente. |
|
Comissão Paga
|
data.items.paid_commission | string |
A comissão paga. |
|
Total de itens
|
data.pagination.total_items | integer |
O número total de itens. |
|
Itens por página
|
data.pagination.items_per_page | string |
Os itens por página. |
|
Índice de Página
|
data.pagination.page_index | string |
O índice da página. |
|
Total de Páginas
|
data.pagination.total_pages | integer |
O número total de páginas. |
Obter breve relatório de vendas
Recupera um breve relatório de vendas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Data de Início
|
start_date | string |
A data de início. |
|
|
Data de Término
|
end_date | string |
A data de término. |
|
|
Limit
|
limit | integer |
O limite. |
|
|
Página
|
page | integer |
O número da página. |
|
|
Agrupar por
|
groupby | string |
O grupo por. |
|
|
IDs do curso
|
course_ids | string |
Os identificadores do curso. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Resposta
|
response_code | integer |
O código de resposta. |
|
Message
|
message | string |
A mensagem de resposta. |
|
Itens
|
data.items | array of object | |
|
Total de vendas
|
data.items.total_sales | integer |
O total de vendas. |
|
ID do Curso
|
data.items.course_id | integer |
O identificador do curso. |
|
Total de ganhos
|
data.items.earnings_total | string |
O total de ganhos. |
|
Total de vendas
|
data.items.sales_total | string |
O total de vendas. |
|
Taxa de Aff
|
data.items.aff_fee | string |
A taxa de afiliada. |
|
Nome
|
data.items.name | string |
O nome. |
|
Day
|
data.items.day | string |
O dia. |
|
Mês
|
data.items.month | string |
O mês. |
|
Moeda
|
data.items.currency | string |
A moeda. |
|
Total de itens
|
data.pagination.total_items | integer |
O número total de itens. |
|
Itens por página
|
data.pagination.items_per_page | integer |
Os itens por página. |
|
Índice de Página
|
data.pagination.page_index | integer |
O índice da página. |
|
Total de Páginas
|
data.pagination.total_pages | integer |
O número total de páginas. |
Obter classes futuras
Recupera uma lista das próximas classes ao vivo.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
O limite. |
|
|
Página
|
page | integer |
O número da página. |
|
|
Ordenar por
|
orderby | string |
A ordem por campo. |
|
|
Pedido
|
order | string |
A ordem. |
|
|
Pesquisa
|
search | string |
O termo de pesquisa. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Resposta
|
response_code | integer |
O código de resposta. |
|
Message
|
message | string |
A mensagem de resposta. |
|
Itens
|
data.items | array of object | |
|
ID
|
data.items.id | integer |
O identificador. |
|
Tópico
|
data.items.topic | string |
O tópico. |
|
Data de Agendamento
|
data.items.schedule_date | string |
A data de agendamento. |
|
Timezone
|
data.items.timezone | string |
O fuso horário. |
|
Duração
|
data.items.duration | integer |
A duração. |
|
Registrar URL
|
data.items.register_url | string |
O endereço de URL do registro. |
|
Recorrente
|
data.items.recurring | boolean |
Se é recorrente. |
|
Agendamento recorrente recente
|
data.items.recent_recurring_schedule | string |
A agenda recorrente recente. |
|
Total de itens
|
data.pagination.total_items | integer |
O número total de itens. |
|
Itens por página
|
data.pagination.items_per_page | integer |
Os itens por página. |
|
Índice de Página
|
data.pagination.page_index | integer |
O índice da página. |
|
Total de Páginas
|
data.pagination.total_pages | integer |
O número total de páginas. |
Obter curso
Recupera um curso por identificador de curso.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Curso
|
course_id | True | string |
O identificador do curso. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Resposta
|
response_code | integer |
O código de resposta. |
|
Message
|
message | string |
A mensagem de resposta. |
|
ID
|
data.items.id | integer |
O identificador. |
|
Nome
|
data.items.name | string |
O nome. |
|
Subtítulo
|
data.items.subtitle | string |
O subtítulo. |
|
Miniatura
|
data.items.thumbnail | string |
A miniatura. |
|
Tipo de curso
|
data.items.course_type | integer |
O tipo de curso. |
|
Proprietário
|
data.items.owner | string |
O proprietário. |
|
ID da escola
|
data.items.school_id | integer |
O identificador da escola. |
|
Público
|
data.items.public | integer |
Seja público. |
|
Destaque
|
data.items.featured | integer |
Se em destaque . |
|
Oculto
|
data.items.hidden | integer |
Se oculto. |
|
Privado
|
data.items.private | integer |
Seja particular. |
Obter detalhes do usuário
Recupere informações sobre um usuário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
user_id | True | string |
O identificador do usuário. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Resposta
|
response_code | integer |
O código de resposta. |
|
Message
|
message | string |
A mensagem de resposta. |
|
ID
|
data.id | string |
O identificador. |
|
Primeiro Nome
|
data.first_name | string |
O nome. |
|
Apelido
|
data.last_name | string |
O sobrenome. |
|
Email
|
data.email | string |
O endereço de email. |
|
Biografia
|
data.bio | string |
A biografia. |
|
Endereço
|
data.address | string |
O endereço. |
|
City
|
data.city | string |
A cidade. |
|
Estado
|
data.state | string |
O Estado. |
|
Código Postal
|
data.zip_code | string |
O cep. |
|
Funções
|
data.roles | array of integer | |
|
Telefone
|
data.phone | string |
O número de telefone. |
Obter funis
Recupera uma lista de funis.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
O limite. |
|
|
Página
|
page | integer |
O número da página. |
|
|
Ordenar por
|
orderby | string |
A ordem por campo. |
|
|
Pedido
|
order | string |
A ordem. |
|
|
Pesquisa
|
search | string |
O termo de pesquisa. |
|
|
Situação
|
status | integer |
O status. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Resposta
|
response_code | integer |
O código de resposta. |
|
Message
|
message | string |
A mensagem de resposta. |
|
Itens
|
data.items | array of object | |
|
ID
|
data.items.id | integer |
O identificador. |
|
Nome
|
data.items.name | string |
O nome. |
|
Tipo
|
data.items.type | string |
O tipo. |
|
URL
|
data.items.url | string |
O endereço da URL. |
|
Total de clientes potenciais
|
data.items.total_leads | integer |
O número total de clientes potenciais. |
|
Miniatura
|
data.items.thumbnail | string |
A miniatura. |
|
Total de itens
|
data.pagination.total_items | integer |
O número total de itens. |
|
Itens por página
|
data.pagination.items_per_page | integer |
Os itens por página. |
|
Índice de Página
|
data.pagination.page_index | integer |
O índice da página. |
|
Total de Páginas
|
data.pagination.total_pages | integer |
O número total de páginas. |
Obter lista de cursos
Recupera uma lista de cursos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
O limite. |
|
|
Página
|
page | integer |
O número da página. |
|
|
Ordenar por
|
orderby | string |
A ordem por campo. |
|
|
Pedido
|
order | string |
A ordem. |
|
|
Pesquisa
|
search | string |
O termo de pesquisa. |
|
|
Tipo
|
type | integer |
O tipo. |
|
|
Situação
|
status | integer |
O status. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Resposta
|
response_code | integer |
O código de resposta. |
|
Message
|
message | string |
A mensagem de resposta. |
|
Itens
|
data.items | array of object | |
|
ID
|
data.items.id | integer |
O identificador. |
|
Nome
|
data.items.name | string |
O nome. |
|
Subtítulo
|
data.items.subtitle | string |
O subtítulo. |
|
Miniatura
|
data.items.thumbnail | string |
A miniatura. |
|
URL
|
data.items.url | string |
O endereço da URL. |
|
Total de itens
|
data.pagination.total_items | integer |
O número total de itens. |
|
Itens por página
|
data.pagination.items_per_page | integer |
Os itens por página. |
|
Índice de Página
|
data.pagination.page_index | integer |
O índice da página. |
|
Total de Páginas
|
data.pagination.total_pages | integer |
O número total de páginas. |
Obter lista de usuários
Recupera uma lista de usuários.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
O limite. |
|
|
Página
|
page | integer |
O número da página. |
|
|
Ordenar por
|
orderby | string |
A ordem por campo. |
|
|
Pedido
|
order | string |
A ordem. |
|
|
Pesquisa
|
search | string |
O termo de pesquisa. |
|
|
Função
|
role | integer |
A função. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Resposta
|
response_code | integer |
O código de resposta. |
|
Message
|
message | string |
A mensagem de resposta. |
|
Itens
|
data.items | array of object | |
|
ID
|
data.items.id | string |
O identificador. |
|
Primeiro Nome
|
data.items.first_name | string |
O nome. |
|
Apelido
|
data.items.last_name | string |
O sobrenome. |
|
Email
|
data.items.email | string |
O endereço de email. |
|
Funções
|
data.items.roles | array of integer |
As funções. |
|
Total de itens
|
data.pagination.total_items | integer |
O número total de itens. |
|
Itens por página
|
data.pagination.items_per_page | integer |
Os itens por página. |
|
Índice de Página
|
data.pagination.page_index | integer |
O índice da página. |
|
Total de Páginas
|
data.pagination.total_pages | integer |
O número total de páginas. |
Obter registros para um funil
Recupera uma lista de registros para um funil.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do funil
|
funnel_id | True | string |
O identificador de funil. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Resposta
|
response_code | integer |
O código de resposta. |
|
Message
|
message | string |
A mensagem de resposta. |
|
Itens
|
data.items | array of object | |
|
ID
|
data.items.id | string |
O identificador. |
|
Primeiro Nome
|
data.items.first_name | string |
O nome. |
|
Apelido
|
data.items.last_name | string |
O sobrenome. |
|
Email
|
data.items.email | string |
O endereço de email. |
|
Registrado em
|
data.items.enrolled_on | string |
Quando registrado. |
Obter um breve relatório de progresso do curso
Recupera um breve relatório do progresso do curso.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Data de Início
|
start_date | string |
A data de início. |
|
|
Data de Término
|
end_date | string |
A data de término. |
|
|
Limit
|
limit | integer |
O limite. |
|
|
Página
|
page | integer |
O número da página. |
|
|
IDs do curso
|
course_ids[] | string |
Os identificadores do curso. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Resposta
|
response_code | integer |
O código de resposta. |
|
Message
|
message | string |
A mensagem de resposta. |
|
ID do Curso
|
data.items.course_number.courseId | integer |
O identificador do curso. |
|
Data de Início
|
data.items.course_number.start_date | string |
A data de início. |
|
Data da Última Data
|
data.items.course_number.last_date | string |
A última data. |
|
Nome do curso
|
data.items.course_number.courseName | string |
O nome do curso. |
|
Total de Alunos
|
data.items.course_number.total_students | integer |
O número total de alunos. |
|
Não Iniciado
|
data.items.course_number.not_started | integer |
Se começou. |
|
Em Andamento
|
data.items.course_number.in_progress | integer |
Se está em andamento. |
|
Concluído
|
data.items.course_number.completed | integer |
Se concluído. |
|
Taxa de Aprovação
|
data.items.course_number.pass_rate | integer |
A taxa de aprovação. |
|
Total de itens
|
data.pagination.total_items | integer |
O número total de itens. |
|
Itens por página
|
data.pagination.items_per_page | string |
Os itens por página. |
|
Índice de Página
|
data.pagination.page_index | string |
O índice da página. |
|
Total de Páginas
|
data.pagination.total_pages | integer |
O número total de páginas. |
Obter um relatório de registros breves
Recupera uma breve lista de registros.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Data de Início
|
start_date | string |
A data de início. |
|
|
Data de Término
|
end_date | string |
A data de término. |
|
|
ID do Curso
|
course_id | string |
O identificador do curso. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Resposta
|
response_code | integer |
O código de resposta. |
|
Message
|
message | string |
A mensagem de resposta. |
|
Itens
|
data.items | array of object | |
|
ID do Curso
|
data.items.course_id | integer |
O identificador do curso. |
|
Nome do curso
|
data.items.course_name | string |
O nome do curso. |
|
Número de registros
|
data.items.no_of_enrollments | integer |
O número de registros. |
|
Total de itens
|
data.pagination.total_items | integer |
O número total de itens. |
|
Itens por página
|
data.pagination.items_per_page | integer |
Os itens por página. |
|
Índice de Página
|
data.pagination.page_index | integer |
O índice da página. |
|
Total de Páginas
|
data.pagination.total_pages | integer |
O número total de páginas. |
Obter um relatório de vendas detalhado
Recupera um relatório de vendas detalhado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Data de Início
|
start_date | string |
A data de início. |
|
|
Data de Término
|
end_date | string |
A data de término. |
|
|
Limit
|
limit | integer |
O limite. |
|
|
Página
|
page | integer |
O número da página. |
|
|
IDs do curso
|
course_ids | string |
Os identificadores do curso. |
|
|
Tipo de pagamento
|
payment_type | integer |
O tipo de pagamento. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Resposta
|
response_code | integer |
O código de resposta. |
|
Message
|
message | string |
A mensagem de resposta. |
|
Itens
|
data.items | array of object | |
|
Criado em
|
data.items.created_at | string |
Quando criado em. |
|
ID da transação
|
data.items.transaction_id | string |
O identificador da transação. |
|
Preço de Vendas
|
data.items.sales_price | string |
O preço de venda. |
|
Ganhar Preço
|
data.items.earn_price | string |
O preço de ganho. |
|
Nome do Aluno
|
data.items.student_name | string |
O nome do aluno. |
|
Email do Aluno
|
data.items.student_email | string |
O endereço de email do aluno. |
|
Curso
|
data.items.course | string |
O curso. |
|
ID do Curso
|
data.items.course_id | integer |
O identificador do curso. |
|
Código de cupom
|
data.items.coupon_code | string |
O código do cupom. |
|
Gateway de Pagamento
|
data.items.payment_gateway | string |
O gateway de pagamento. |
|
Total de itens
|
data.pagination.total_items | integer |
O número total de itens. |
|
Itens por página
|
data.pagination.items_per_page | integer |
Os itens por página. |
|
Índice de Página
|
data.pagination.page_index | integer |
O índice da página. |
|
Total de Páginas
|
data.pagination.total_pages | integer |
O número total de páginas. |
Obter um relatório detalhado de afiliadas
Recupera um relatório detalhado de afiliadas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Data de Início
|
start_date | string |
A data de início. |
|
|
Data de Término
|
end_date | string |
A data de término. |
|
|
Limit
|
limit | integer |
O limite. |
|
|
Página
|
page | integer |
O número da página. |
|
|
IDs do curso
|
course_ids[] | string |
Os identificadores do curso. |
|
|
IDs de afiliadas
|
affiliate_ids[] | string |
Os identificadores de afiliada. |
|
|
Filtro Avançado
|
af_v | string |
O filtro avançado. |
|
|
Cupom É
|
coupon_is[] | string |
O cupom é. |
|
|
Cupom Like
|
coupon_like[] | string |
O cupom é como. |
|
|
O nome é
|
name_is[] | string |
O nome é. |
|
|
Name Like
|
name_like[] | string |
O nome é como. |
|
|
O email é
|
email_is[] | string |
O email é. |
|
|
Email como
|
email_like[] | string |
O email é como. |
|
|
Afiliado é
|
affiliate_is[] | string |
A afiliada é. |
|
|
Tipo de pagamento
|
payment_type | string |
O tipo de pagamento. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Resposta
|
response_code | integer |
O código de resposta. |
|
Message
|
message | string |
A mensagem de resposta. |
|
Itens
|
data.items | array of object | |
|
Curso
|
data.items.course | string |
O curso. |
|
Criado em
|
data.items.created_at | string |
Quando criado em. |
|
Preço de Vendas
|
data.items.sales_price | string |
O preço de venda. |
|
Desconto de cupom
|
data.items.coupon_discount | string |
O desconto do cupom. |
|
Comissão
|
data.items.commission | string |
A comissão. |
|
Status do pagamento
|
data.items.payout_status | string |
O status do pagamento. |
|
Total de itens
|
data.pagination.total_items | integer |
O número total de itens. |
|
Itens por página
|
data.pagination.items_per_page | integer |
Os itens por página. |
|
Índice de Página
|
data.pagination.page_index | integer |
O índice da página. |
|
Total de Páginas
|
data.pagination.total_pages | integer |
O número total de páginas. |
Obter um relatório detalhado de progresso do curso
Recupera um relatório detalhado do progresso do curso.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Data de Início
|
start_date | string |
A data de início. |
|
|
Data de Término
|
end_date | string |
A data de término. |
|
|
Limit
|
limit | integer |
O limite. |
|
|
Página
|
page | integer |
O número da página. |
|
|
IDs do curso
|
course_ids[] | string |
Os identificadores do curso. |
|
|
Filtro Avançado
|
af_v | string |
O filtro avançado. |
|
|
Cupom É
|
coupon_is[] | string |
O cupom é. |
|
|
Cupom Like
|
coupon_like[] | string |
O cupom é como. |
|
|
O nome é
|
name_is[] | string |
O nome é. |
|
|
Name Like
|
name_like[] | string |
O nome é como. |
|
|
O email é
|
email_is[] | string |
O email é. |
|
|
Email como
|
email_like[] | string |
O email é como. |
|
|
Afiliado é
|
affiliate_is[] | string |
A afiliada é. |
|
|
Tipo de pagamento
|
payment_type | integer |
O tipo de pagamento. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Resposta
|
response_code | integer |
O código de resposta. |
|
Message
|
message | string |
A mensagem de resposta. |
|
UID
|
data.items.course_number.uid | string |
O identificador exclusivo. |
|
ID do Curso
|
data.items.course_number.courseId | string |
O identificador do curso. |
|
Nome
|
data.items.course_number.name | string |
O nome. |
|
Email
|
data.items.course_number.email | string |
O endereço de email. |
|
Data do registro
|
data.items.course_number.enrollment_date | string |
A data de registro. |
|
Data de Início
|
data.items.course_number.start_date | string |
A data de início. |
|
Data concluída
|
data.items.course_number.completed_date | string |
A data concluída. |
|
Situação
|
data.items.course_number.status | string |
O status. |
|
Última participação
|
data.items.course_number.last_attended | string |
Quando compareceu pela última vez. |
|
Porcentagem de conclusão
|
data.items.course_number.completion_percentage | integer |
O percentual de conclusão. |
|
Total de itens
|
data.pagination.total_items | integer |
O número total de itens. |
|
Itens por página
|
data.pagination.items_per_page | string |
Os itens por página. |
|
Índice de Página
|
data.pagination.page_index | string |
O índice da página. |
|
Total de Páginas
|
data.pagination.total_pages | integer |
O número total de páginas. |
Obter um relatório detalhado de registros
Recupera uma lista detalhada de registros.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Data de Início
|
start_date | string |
A data de início. |
|
|
Data de Término
|
end_date | string |
A data de término. |
|
|
ID do Curso
|
course_id | string |
O identificador do curso. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Resposta
|
response_code | integer |
O código de resposta. |
|
Message
|
message | string |
A mensagem de resposta. |
|
Itens
|
data.items | array of object | |
|
ID do Curso
|
data.items.course_id | integer |
O identificador do curso. |
|
ID do Usuário
|
data.items.user_id | string |
O identificador do usuário. |
|
Nome do curso
|
data.items.course_name | string |
O nome do curso. |
|
Primeiro Nome
|
data.items.first_name | string |
O nome. |
|
Apelido
|
data.items.last_name | string |
O sobrenome. |
|
Email
|
data.items.email | string |
O endereço de email. |
|
Data do registro
|
data.items.enrollment_date | string |
A data de registro. |
Obter webinars futuros
Recupere uma lista de webinars ao vivo futuros.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
O limite. |
|
|
Página
|
page | integer |
O número da página. |
|
|
Ordenar por
|
orderby | string |
A ordem por campo. |
|
|
Pedido
|
order | string |
A ordem. |
|
|
Pesquisa
|
search | string |
O termo de pesquisa. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Resposta
|
response_code | integer |
O código de resposta. |
|
Message
|
message | string |
A mensagem de resposta. |
|
Itens
|
data.items | array of object | |
|
ID
|
data.items.id | integer |
O identificador. |
|
Tópico
|
data.items.topic | string |
O tópico. |
|
Data de Agendamento
|
data.items.schedule_date | string |
A data de agendamento. |
|
Timezone
|
data.items.timezone | string |
O fuso horário. |
|
Duração
|
data.items.duration | integer |
A duração. |
|
Registrar URL
|
data.items.register_url | string |
O endereço de URL do registro. |
|
Recorrente
|
data.items.recurring | boolean |
Se é recorrente. |
|
Agendamento recorrente recente
|
data.items.recent_recurring_schedule | string |
A agenda recorrente recente. |
|
Total de itens
|
data.pagination.total_items | integer |
O número total de itens. |
|
Itens por página
|
data.pagination.items_per_page | integer |
Os itens por página. |
|
Índice de Página
|
data.pagination.page_index | integer |
O índice da página. |
|
Total de Páginas
|
data.pagination.total_pages | integer |
O número total de páginas. |
Registrar-se para a classe
Registre um usuário para uma classe dinâmica.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da classe ao vivo
|
liveclass_id | True | string |
O identificador de classe dinâmica. |
|
Nome
|
name | True | string |
O nome. |
|
Email
|
True | string |
O endereço de email. |
|
|
Apelido
|
last_name | string |
O sobrenome. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Resposta
|
response_code | integer |
O código de resposta. |
|
Message
|
message | string |
A mensagem de resposta. |
|
Nome
|
data.name | string |
O nome. |
|
Email
|
data.email | string |
O endereço de email. |
|
Classe dinâmica
|
data.live class | string |
A classe ao vivo. |
|
Message
|
data.message | string |
A mensagem. |
Registrar-se para webinar
Registre um usuário para um webinar dinâmico.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Webinar ID
|
webinar_id | True | string |
O identificador webinar. |
|
Nome
|
name | True | string |
O nome. |
|
Email
|
True | string |
O endereço de email. |
|
|
Apelido
|
last_name | string |
O sobrenome. |
|
|
Endereço
|
address | string |
O endereço. |
|
|
City
|
city | string |
A cidade. |
|
|
Estado
|
state | string |
O estado. |
|
|
Telefone
|
phone | string |
O número de telefone. |
|
|
Código Postal
|
zip_code | integer |
O cep. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Resposta
|
response_code | integer |
O código de resposta. |
|
Message
|
message | string |
A mensagem de resposta. |
|
Nome
|
data.name | string |
O nome. |
|
Email
|
data.email | string |
O endereço de email. |
|
Webinar ao vivo
|
data.live webinar | string |
O webinar ao vivo. |
|
Message
|
data.message | string |
A mensagem. |
Registrar um usuário
Registra um usuário em um curso.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Usuário
|
user_id | True | string |
O identificador do usuário. |
|
ID do Curso
|
course_id | True | string |
O identificador do curso. |
|
ID do Plano
|
plan_id | string |
O identificador do plano. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Resposta
|
response_code | integer |
O código de resposta. |
|
Message
|
message | string |
A mensagem de resposta. |
|
Dados
|
data | string |
Os dados. |