Zenler (Editora Independente) (Pré-visualização)
Zenler é uma plataforma completa de criação, entrega e marketing de cursos.
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Aplicações Power | Premium | Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Automatize o poder | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Troia Taylor |
| URL | https://www.hitachisolutions.com |
| ttaylor@hitachisolutions.com |
| Metadados do conector | |
|---|---|
| Editora | Troia Taylor |
| Sítio Web | https://www.newzenler.com/ |
| Política de privacidade | https://www.newzenler.com/privacy-policy |
| Categorias | Gestão de Empresas |
A criar uma ligação
O conector suporta os seguintes tipos de autenticação:
| Predefinição | 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.
Esta conexão não é compartilhável. Se o aplicativo avançado 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 |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Adicionar utilizador |
Cria um novo usuário. |
| Atualizar utilizador |
Atualiza as informações de um usuário. |
| Cancelar inscrição do funil |
Cancela a inscrição de um usuário de um funil. |
| Cancelar inscrição no webinar |
Cancele o registro de um usuário para um webinar ao vivo. |
| Cancelar o registro de um usuário |
Cancela a inscrição de um usuário de um curso. |
| Cancelar o registro para a classe |
Cancele o registro de um usuário para uma aula ao vivo. |
| Eliminar um utilizador |
Remova um utilizador da sua conta. |
| Inscreva-se na aula |
Registre um usuário para uma aula ao vivo. |
| Inscreva-se no webinar |
Registre um usuário para um webinar ao vivo. |
| Inscrever um usuário |
Inscreve um usuário em um curso. |
| Obtenha um breve relatório de afiliados |
Recupera um breve relatório de afiliados. |
| Obtenha um breve relatório de inscrições |
Recupera uma breve lista de inscrições. |
| Obtenha um breve relatório de progresso do curso |
Recupera um breve relatório do progresso do curso. |
| Obtenha um breve relatório de vendas |
Recupera um breve relatório de vendas. |
| Obtenha um relatório de vendas detalhado |
Recupera um relatório de vendas detalhado. |
| Obtenha um relatório detalhado de afiliados |
Recupera um relatório detalhado de afiliados. |
| Obtenha um relatório detalhado de inscrições |
Recupera uma lista detalhada de inscrições. |
| Obtenha um relatório detalhado sobre o progresso do curso |
Recupera um relatório detalhado do progresso do curso. |
| Obter curso |
Recupera um identificador de curso por curso. |
| Obter detalhes do utilizador |
Recuperar informações sobre um usuário. |
| Obter funis |
Recupera uma lista de funis. |
| Obter inscrições para um funil |
Recupera uma lista de inscrições para um funil. |
| Obter lista de cursos |
Recupera uma lista de cursos. |
| Obter lista de usuários |
Recupera uma lista de usuários. |
| Receba as próximas aulas |
Recupera uma lista das próximas aulas ao vivo. |
| Receba os próximos webinars |
Recupere uma lista dos próximos webinars ao vivo. |
| Subscrever funil |
Inscreva um usuário em um funil. |
Adicionar utilizador
Cria um novo usuário.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome Próprio
|
first_name | True | string |
O primeiro nome. |
|
Apelido
|
last_name | True | string |
O sobrenome. |
|
Email
|
True | string |
O endereço de e-mail. |
|
|
Palavra-passe
|
password | True | string |
A senha. |
|
Comissão
|
commission | True | integer |
A comissão. |
|
Funções
|
roles | True | string |
Os papéis. |
|
Address
|
address | string |
O endereço. |
|
|
City
|
city | string |
A cidade. |
|
|
Estado
|
state | string |
O Estado. |
|
|
Telemóvel
|
phone | string |
O número de telefone. |
|
|
Código Postal
|
zip_code | integer |
O código postal. |
|
|
Country
|
country | string |
O país. |
|
|
Estado de Consentimento do RGPD
|
gdpr_consent_status | integer |
O estado de consentimento do RGPD. |
Devoluções
| Name | 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. |
|
Nome Próprio
|
data.first_name | string |
O primeiro nome. |
|
Apelido
|
data.last_name | string |
O sobrenome. |
|
Email
|
data.email | string |
O endereço de e-mail. |
Atualizar utilizador
Atualiza as informações de um usuário.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de utilizador
|
user_id | True | string |
O identificador do usuário. |
|
Nome Próprio
|
first_name | True | string |
O primeiro nome. |
|
Apelido
|
last_name | True | string |
O sobrenome. |
|
Email
|
True | string |
O endereço de e-mail. |
|
|
Palavra-passe
|
password | True | string |
A senha. |
|
Comissão
|
commission | True | integer |
A comissão. |
|
Funções
|
roles | True | string |
Os papéis. |
|
Address
|
address | string |
O endereço. |
|
|
City
|
city | string |
A cidade. |
|
|
Estado
|
state | string |
O Estado. |
|
|
Telemóvel
|
phone | string |
O número de telefone. |
|
|
Código Postal
|
zip_code | integer |
O código postal. |
|
|
Country
|
country | string |
O país. |
|
|
Estado de Consentimento do RGPD
|
gdpr_consent_status | integer |
O estado de consentimento do RGPD. |
Devoluções
| Name | 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 inscrição do funil
Cancela a inscrição de um usuário de um funil.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do funil
|
funnel_id | True | string |
O identificador de funil. |
|
Email
|
string |
O e-mail. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Resposta
|
response_code | integer |
O código de resposta. |
|
Message
|
message | string |
A mensagem de resposta. |
|
Data
|
data | string |
Os dados. |
Cancelar inscrição no webinar
Cancele o registro de um usuário para um webinar ao vivo.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Webinar ID
|
webinar_id | True | string |
O identificador do webinar. |
|
Email
|
True | string |
O endereço de e-mail. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Resposta
|
response_code | integer |
O código de resposta. |
|
Message
|
message | string |
A mensagem de resposta. |
|
Data
|
data | string |
Os dados. |
Cancelar o registro de um usuário
Cancela a inscrição de um usuário de um curso.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de utilizador
|
user_id | True | string |
O identificador do usuário. |
|
ID do curso
|
course_id | True | string |
O identificador do curso. |
Devoluções
| Name | 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 a classe
Cancele o registro de um usuário para uma aula ao vivo.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da classe ao vivo
|
liveclass_id | True | string |
O identificador de classe ao vivo. |
|
Email
|
string |
O e-mail. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Resposta
|
response_code | integer |
O código de resposta. |
|
Message
|
message | string |
A mensagem de resposta. |
|
Data
|
data | string |
Os dados. |
Eliminar um utilizador
Remova um utilizador da sua conta.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de utilizador
|
user_id | True | string |
O identificador do usuário. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Resposta
|
response_code | integer |
O código de resposta. |
|
Message
|
message | string |
A mensagem de resposta. |
|
Data
|
data | string |
Os dados. |
Inscreva-se na aula
Registre um usuário para uma aula ao vivo.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da classe ao vivo
|
liveclass_id | True | string |
O identificador de classe ao vivo. |
|
Nome
|
name | True | string |
O nome. |
|
Email
|
True | string |
O endereço de e-mail. |
|
|
Apelido
|
last_name | string |
O sobrenome. |
Devoluções
| Name | 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 e-mail. |
|
Aula ao vivo
|
data.live class | string |
A aula ao vivo. |
|
Message
|
data.message | string |
A mensagem. |
Inscreva-se no webinar
Registre um usuário para um webinar ao vivo.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Webinar ID
|
webinar_id | True | string |
O identificador do webinar. |
|
Nome
|
name | True | string |
O nome. |
|
Email
|
True | string |
O endereço de e-mail. |
|
|
Apelido
|
last_name | string |
O sobrenome. |
|
|
Address
|
address | string |
O endereço. |
|
|
City
|
city | string |
A cidade. |
|
|
Estado
|
state | string |
O Estado. |
|
|
Telemóvel
|
phone | string |
O número de telefone. |
|
|
Código Postal
|
zip_code | integer |
O código postal. |
Devoluções
| Name | 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 e-mail. |
|
Webinar ao vivo
|
data.live webinar | string |
O webinar ao vivo. |
|
Message
|
data.message | string |
A mensagem. |
Inscrever um usuário
Inscreve um usuário em um curso.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de utilizador
|
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. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Resposta
|
response_code | integer |
O código de resposta. |
|
Message
|
message | string |
A mensagem de resposta. |
|
Data
|
data | string |
Os dados. |
Obtenha um breve relatório de afiliados
Recupera um breve relatório de afiliados.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Data de início
|
start_date | string |
A data de início. |
|
|
Data de fim
|
end_date | string |
A data de término. |
|
|
Limite
|
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 afiliado
|
affiliate_ids[] | string |
Os identificadores de afiliados. |
Devoluções
| Name | 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 afiliado. |
|
Nome Aff
|
data.items.aff_name | string |
O nome do afiliado. |
|
Endereço eletrónico Aff
|
data.items.aff_email | string |
O endereço de e-mail do afiliado. |
|
Contagem total de vendas
|
data.items.total_sales_count | integer |
O total de vendas conta. |
|
Total Comissão
|
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 da 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. |
Obtenha um breve relatório de inscrições
Recupera uma breve lista de inscrições.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Data de início
|
start_date | string |
A data de início. |
|
|
Data de fim
|
end_date | string |
A data de término. |
|
|
ID do curso
|
course_id | string |
O identificador do curso. |
Devoluções
| Name | 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 Inscrições
|
data.items.no_of_enrollments | integer |
O número de inscriçõ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 da 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. |
Obtenha um breve relatório de progresso do curso
Recupera um breve relatório do progresso do curso.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Data de início
|
start_date | string |
A data de início. |
|
|
Data de fim
|
end_date | string |
A data de término. |
|
|
Limite
|
limit | integer |
O limite. |
|
|
Página
|
page | integer |
O número da página. |
|
|
IDs do curso
|
course_ids[] | string |
Os identificadores do curso. |
Devoluções
| Name | 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. |
|
Ú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 curso
|
data.items.course_number.in_progress | integer |
Se em curso. |
|
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 da 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. |
Obtenha um breve relatório de vendas
Recupera um breve relatório de vendas.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Data de início
|
start_date | string |
A data de início. |
|
|
Data de fim
|
end_date | string |
A data de término. |
|
|
Limite
|
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. |
Devoluções
| Name | 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 |
As vendas totais. |
|
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. |
|
Aff Taxa
|
data.items.aff_fee | string |
A taxa de afiliado. |
|
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 da 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. |
Obtenha um relatório de vendas detalhado
Recupera um relatório de vendas detalhado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Data de início
|
start_date | string |
A data de início. |
|
|
Data de fim
|
end_date | string |
A data de término. |
|
|
Limite
|
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. |
Devoluções
| Name | 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 Venda
|
data.items.sales_price | string |
O preço de venda. |
|
Ganhe Preço
|
data.items.earn_price | string |
O preço de ganho. |
|
Nome do Aluno
|
data.items.student_name | string |
O nome do aluno. |
|
E-mail do aluno
|
data.items.student_email | string |
O endereço de e-mail do aluno. |
|
Course
|
data.items.course | string |
O curso. |
|
ID do curso
|
data.items.course_id | integer |
O identificador do curso. |
|
Código do 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 da 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. |
Obtenha um relatório detalhado de afiliados
Recupera um relatório detalhado de afiliados.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Data de início
|
start_date | string |
A data de início. |
|
|
Data de fim
|
end_date | string |
A data de término. |
|
|
Limite
|
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 afiliado
|
affiliate_ids[] | string |
Os identificadores de afiliados. |
|
|
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 é. |
|
|
Nome Like
|
name_like[] | string |
O nome é assim. |
|
|
O e-mail é
|
email_is[] | string |
O e-mail é. |
|
|
E-mail como
|
email_like[] | string |
O e-mail é como. |
|
|
Afiliado é
|
affiliate_is[] | string |
O afiliado é. |
|
|
Tipo de Pagamento
|
payment_type | string |
O tipo de pagamento. |
Devoluções
| Name | 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 | |
|
Course
|
data.items.course | string |
O curso. |
|
Criado em
|
data.items.created_at | string |
Quando criado em. |
|
Preço de Venda
|
data.items.sales_price | string |
O preço de venda. |
|
Cupom de desconto
|
data.items.coupon_discount | string |
O cupom de desconto. |
|
Comissão
|
data.items.commission | string |
A comissão. |
|
Estado do Pagamento
|
data.items.payout_status | string |
O estado 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 da 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. |
Obtenha um relatório detalhado de inscrições
Recupera uma lista detalhada de inscrições.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Data de início
|
start_date | string |
A data de início. |
|
|
Data de fim
|
end_date | string |
A data de término. |
|
|
ID do curso
|
course_id | string |
O identificador do curso. |
Devoluções
| Name | 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 de utilizador
|
data.items.user_id | string |
O identificador do usuário. |
|
Nome do curso
|
data.items.course_name | string |
O nome do curso. |
|
Nome Próprio
|
data.items.first_name | string |
O primeiro nome. |
|
Apelido
|
data.items.last_name | string |
O sobrenome. |
|
Email
|
data.items.email | string |
O endereço de e-mail. |
|
Data de Inscrição
|
data.items.enrollment_date | string |
A data de inscrição. |
Obtenha um relatório detalhado sobre o progresso do curso
Recupera um relatório detalhado do progresso do curso.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Data de início
|
start_date | string |
A data de início. |
|
|
Data de fim
|
end_date | string |
A data de término. |
|
|
Limite
|
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 é. |
|
|
Nome Like
|
name_like[] | string |
O nome é assim. |
|
|
O e-mail é
|
email_is[] | string |
O e-mail é. |
|
|
E-mail como
|
email_like[] | string |
O e-mail é como. |
|
|
Afiliado é
|
affiliate_is[] | string |
O afiliado é. |
|
|
Tipo de Pagamento
|
payment_type | integer |
O tipo de pagamento. |
Devoluções
| Name | 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 único. |
|
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 e-mail. |
|
Data de Inscrição
|
data.items.course_number.enrollment_date | string |
A data de inscrição. |
|
Data de início
|
data.items.course_number.start_date | string |
A data de início. |
|
Data de Conclusão
|
data.items.course_number.completed_date | string |
A data de conclusão. |
|
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. |
|
Percentagem de conclusão
|
data.items.course_number.completion_percentage | integer |
A percentagem 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 da 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 curso
Recupera um identificador de curso por curso.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do curso
|
course_id | True | string |
O identificador do curso. |
Devoluções
| Name | 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. |
|
Identificação escolar
|
data.items.school_id | integer |
O identificador da escola. |
|
Public
|
data.items.public | integer |
Se público. |
|
Em destaque
|
data.items.featured | integer |
Se em destaque . |
|
Escondido
|
data.items.hidden | integer |
Se escondido. |
|
Privado
|
data.items.private | integer |
Se privado. |
Obter detalhes do utilizador
Recuperar informações sobre um usuário.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de utilizador
|
user_id | True | string |
O identificador do usuário. |
Devoluções
| Name | 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. |
|
Nome Próprio
|
data.first_name | string |
O primeiro nome. |
|
Apelido
|
data.last_name | string |
O sobrenome. |
|
Email
|
data.email | string |
O endereço de e-mail. |
|
Biografia
|
data.bio | string |
A biografia. |
|
Address
|
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 código postal. |
|
Funções
|
data.roles | array of integer | |
|
Telemóvel
|
data.phone | string |
O número de telefone. |
Obter funis
Recupera uma lista de funis.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Limite
|
limit | integer |
O limite. |
|
|
Página
|
page | integer |
O número da página. |
|
|
Encomendar por
|
orderby | string |
A ordem por campo. |
|
|
Encomenda
|
order | string |
A ordem. |
|
|
Pesquisa
|
search | string |
O termo de pesquisa. |
|
|
Situação
|
status | integer |
O status. |
Devoluções
| Name | 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 URL. |
|
Total Leads
|
data.items.total_leads | integer |
O número total de leads. |
|
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 da 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 inscrições para um funil
Recupera uma lista de inscrições para um funil.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do funil
|
funnel_id | True | string |
O identificador de funil. |
Devoluções
| Name | 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. |
|
Nome Próprio
|
data.items.first_name | string |
O primeiro nome. |
|
Apelido
|
data.items.last_name | string |
O sobrenome. |
|
Email
|
data.items.email | string |
O endereço de e-mail. |
|
Inscrito em
|
data.items.enrolled_on | string |
Quando inscrito. |
Obter lista de cursos
Recupera uma lista de cursos.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Limite
|
limit | integer |
O limite. |
|
|
Página
|
page | integer |
O número da página. |
|
|
Encomendar por
|
orderby | string |
A ordem por campo. |
|
|
Encomenda
|
order | string |
A ordem. |
|
|
Pesquisa
|
search | string |
O termo de pesquisa. |
|
|
Tipo
|
type | integer |
O tipo. |
|
|
Situação
|
status | integer |
O status. |
Devoluções
| Name | 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 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 da 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
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Limite
|
limit | integer |
O limite. |
|
|
Página
|
page | integer |
O número da página. |
|
|
Encomendar por
|
orderby | string |
A ordem por campo. |
|
|
Encomenda
|
order | string |
A ordem. |
|
|
Pesquisa
|
search | string |
O termo de pesquisa. |
|
|
Funções
|
role | integer |
O papel. |
Devoluções
| Name | 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. |
|
Nome Próprio
|
data.items.first_name | string |
O primeiro nome. |
|
Apelido
|
data.items.last_name | string |
O sobrenome. |
|
Email
|
data.items.email | string |
O endereço de e-mail. |
|
Funções
|
data.items.roles | array of integer |
Os papéis. |
|
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 da 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. |
Receba as próximas aulas
Recupera uma lista das próximas aulas ao vivo.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Limite
|
limit | integer |
O limite. |
|
|
Página
|
page | integer |
O número da página. |
|
|
Encomendar por
|
orderby | string |
A ordem por campo. |
|
|
Encomenda
|
order | string |
A ordem. |
|
|
Pesquisa
|
search | string |
O termo de pesquisa. |
Devoluções
| Name | 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 tema. |
|
Data do Agendamento
|
data.items.schedule_date | string |
A data do cronograma. |
|
Timezone
|
data.items.timezone | string |
O fuso horário. |
|
Duração
|
data.items.duration | integer |
A duração. |
|
URL de registo
|
data.items.register_url | string |
O endereço URL do registo. |
|
Recorrente
|
data.items.recurring | boolean |
Se recorrente. |
|
Programação recorrente recente
|
data.items.recent_recurring_schedule | string |
A recente agenda recorrente. |
|
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 da 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. |
Receba os próximos webinars
Recupere uma lista dos próximos webinars ao vivo.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Limite
|
limit | integer |
O limite. |
|
|
Página
|
page | integer |
O número da página. |
|
|
Encomendar por
|
orderby | string |
A ordem por campo. |
|
|
Encomenda
|
order | string |
A ordem. |
|
|
Pesquisa
|
search | string |
O termo de pesquisa. |
Devoluções
| Name | 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 tema. |
|
Data do Agendamento
|
data.items.schedule_date | string |
A data do cronograma. |
|
Timezone
|
data.items.timezone | string |
O fuso horário. |
|
Duração
|
data.items.duration | integer |
A duração. |
|
URL de registo
|
data.items.register_url | string |
O endereço URL do registo. |
|
Recorrente
|
data.items.recurring | boolean |
Se recorrente. |
|
Programação recorrente recente
|
data.items.recent_recurring_schedule | string |
A recente agenda recorrente. |
|
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 da 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. |
Subscrever funil
Inscreva um usuário em um funil.
Parâmetros
| Name | Chave | Necessá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 e-mail. |
|
|
Apelido
|
last_name | string |
O sobrenome. |
|
|
Address
|
address | string |
O endereço. |
|
|
City
|
city | string |
A cidade. |
|
|
Estado
|
state | string |
O Estado. |
|
|
Telemóvel
|
phone | string |
O número de telefone. |
|
|
Código Postal
|
zip_code | integer |
O código postal. |
|
|
Country
|
country | string |
O país. |
|
|
Estado de Consentimento do RGPD
|
gdpr_consent_status | integer |
O estado de consentimento do RGPD. |
Devoluções
| Name | 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 e-mail. |
|
Funil
|
data.funnel | string |
O funil. |