Partilhar via


Eduframe

O Eduframe é uma solução completa para provedores de treinamento comercial ou escolas de negócios para atrair mais alunos, gerenciar e automatizar a administração do curso e oferecer a melhor experiência de aprendizagem. O Eduframe integra-se perfeitamente ao Canvas LMS. O conector abre a oportunidade de integrar facilmente seus aplicativos de software existentes com o Eduframe, como seu CRM e software de contabilidade.

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 Equipa de Desenvolvimento Eduframe
URL https://eduframe.co
Email dev@drieam.nl
Metadados do conector
Editora Microsoft
Sítio Web https://eduframe.co
Política de privacidade https://drieam.com/security-and-privacy/
Categorias Data

O Eduframe gerencia e automatiza a administração de cursos para provedores de treinamento comercial e escolas de negócios. Usando este conector é possível conectar diferentes ferramentas em conjunto com o Eduframe para gerenciar automaticamente cursos, usuários, faturas e muito mais.

Pré-requisitos

Para fazer uso deste conector, você precisará de uma licença Eduframe. Você pode encontrar mais informações sobre o Eduframe e como obter uma licença aqui.

Se já tiver uma licença Eduframe, certifique-se de que as Aplicações Lógicas do Azure estão ativadas para o seu ambiente. Se você quiser habilitar essa integração, você pode enviar um e-mail support@eduframe.nlpara .

Como obter credenciais

Se utilizar este conector pela primeira vez, ser-lhe-á pedido para iniciar sessão no Eduframe e autorizar este conector. Uma vez autorizado, você será capaz de usar este conector e todos os seus recursos.

Introdução ao conector

O Eduframe fornece webhooks que atuam como gatilhos para suas automações. Podemos criar um novo fluxo que será acionado toda vez que um novo usuário for adicionado ao Eduframe. Ao criar um novo fluxo, você pode selecionar esse conector e escolher 'Assinar webhook' como um gatilho. Em seguida, em 'events Item' selecione 'user.created'. Você pode adicionar mais, mas por enquanto só estamos interessados neste.

Em seguida, queremos saber qual usuário foi adicionado ao eduframe. Para fazer isso, podemos adicionar uma nova etapa deste conector chamada 'Obter um usuário'. Esta etapa exigirá um ID de um usuário. Podemos usar o ID da entidade do webhook.

Agora que sabemos quem é o novo usuário no Eduframe, podemos enviar um e-mail para essa pessoa. Como exemplo, usaremos o conector do Outlook, mas isso pode ser qualquer provedor de email. Adicione um novo passo e selecione 'Enviar um e-mail'. Aqui podemos preencher o e-mail do usuário, um assunto e o e-mail que queremos enviar. Observe que no corpo do e-mail você pode usar outros atributos do usuário, como nome e sobrenome.

Quando terminarmos de escrever o e-mail, podemos salvar esse fluxo. Agora, sempre que um novo usuário for adicionado ao Eduframe, essa pessoa receberá um e-mail de boas-vindas.

Limites de Limitação

Name Chamadas Período de Renovação
Chamadas de API por conexão 100 60 segundos

Ações

Adicionar um curso

Adicione um curso à sua administração.

Adicionar um IVA de fatura

Adicione um iva da fatura que pode ser usado na fatura.

Adicionar um utilizador

Adicione um usuário à sua administração.

Adicionar uma autenticação

Adicionar um método de autenticação a um utilizador existente

Adicionar uma categoria

Adicione uma categoria à sua administração.

Adicionar uma conta

Adicione uma conta à sua administração.

Adicionar uma fatura

Adicione uma fatura à sua administração.

Excluir uma autenticação de um usuário

Exclua uma das autenticações de um usuário. Observe que você não pode excluir a última autenticação!

Listar todas as categorias

Obtenha todas as categorias.

Listar todas as contas

Obtenha todas as contas.

Listar todas as faturas

Obtenha todas as faturas.

Listar todos os cursos

Obtenha todos os cursos.

Listar todos os rótulos

Obtenha todos os rótulos.

Listar todos os usuários

Obtenha todos os usuários.

Listar todos os vats de fatura

Obter todos os vats de fatura

Obter as autenticações de um usuário

Obtenha uma lista de autenticações que pertencem a um usuário específico.

Obter todas as variantes do catálogo

Obtenha todas as variantes do catálogo.

Obter um curso

Obtenha um único curso por id

Obter um utilizador

Obtenha um único usuário por id.

Obter uma categoria

Obter uma categoria por id

Obter uma conta

Obtenha uma conta por id.

Obter uma fatura

Obtenha uma única fatura por id.

Adicionar um curso

Adicione um curso à sua administração.

Parâmetros

Name Chave Necessário Tipo Description
id
id integer

Identificador único do curso

nome
name True string

O nome do curso.

posição
position number

Classificação da posição do curso. Mais baixo é mais alto.

signup_url
signup_url string

URL para a página de inscrição deste curso.

slug_history
slug_history array of string

Lista de lesmas antigas, chamadas antigas serão redirecionadas.

Avatar
avatar string

URL para uma imagem de avatar redimensionada (300x200^).

certificate_template_id
certificate_template_id number

Identificador do modelo de certificado vinculado opcionalmente.

Categoria
category_id True number

Identificador da categoria do curso.

código
code True string

O código do curso.

custo
cost string

O preço a pagar por este curso.

cost_scheme
cost_scheme string

Como o curso deve ser pago por defeito?

is_published
is_published boolean

Booleano representando o status publicável do curso.

updated_at
updated_at string

Carimbo de data/hora da última atualização.

criado_em
created_at string

Carimbo de data/hora da criação.

Devoluções

Body
course

Adicionar um IVA de fatura

Adicione um iva da fatura que pode ser usado na fatura.

Parâmetros

Name Chave Necessário Tipo Description
id
id integer

Identificador único do IVA da fatura.

nome
name True string

Nome do IVA da fatura.

percentagem
percentage True string

Número que representa a percentagem do IVA.

Devoluções

Adicionar um utilizador

Adicione um usuário à sua administração.

Parâmetros

Name Chave Necessário Tipo Description
Nome próprio
first_name True string

Nome próprio do utilizador.

Nome do meio
middle_name string

Nome do meio do usuário.

Apelido
last_name True string

Apelido do utilizador.

Email
email True string

O e-mail do usuário.

Número de telefone
phone string

O número de telefone do utilizador.

Subscrever a newsletter
wants_newsletter boolean

O utilizador deseja receber newsletters?

Criar autenticação
with_authentication boolean

Crie uma autenticação para o usuário, de modo que o usuário possa fazer login.

região
locale string

A localidade do usuário.

label_ids
label_ids array of number
id
id integer

Identificador único do endereço.

Destinatário
addressee string

O destinatário do endereço.

address
address True string

Concatenação da rua e número da casa.

código postal
postal_code True string

Uma cadeia de caracteres que representa o código postal.

city
city True string

Uma cadeia de caracteres que representa a cidade.

country
country True string

Uma cadeia de caracteres que representa o país.

updated_at
updated_at string

Carimbo de data/hora da última atualização.

criado_em
created_at string

Carimbo de data/hora da criação.

notes_user
notes_user string

Nota curta sobre o utilizador.

Devoluções

Body
user

Adicionar uma autenticação

Adicionar um método de autenticação a um utilizador existente

Parâmetros

Name Chave Necessário Tipo Description
user_id
user_id True integer

A id do usuário ao qual essa autenticação pertence.

authentication_provider_type
authentication_provider_type True string

O tipo do provedor de autenticação.

uid
uid True string

O identificador exclusivo dessa autenticação que corresponde a um id exclusivo do IDP.

Devoluções

Adicionar uma categoria

Adicione uma categoria à sua administração.

Parâmetros

Name Chave Necessário Tipo Description
id
id integer

Identificador único da categoria.

Nome
name True string

Título da categoria.

Description
description string

A descrição da categoria.

posição
position number

Classificação da posição da categoria. Mais baixo é mais alto.

parent_id
parent_id number

Identificador exclusivo da categoria pai

Avatar
avatar string

URL para o avatar da categoria.

Publicado
is_published boolean

Se a categoria deve ser publicada no site.

courses_count
courses_count number

Número de cursos diretamente ligados a esta categoria.

children_count
children_count number

Número de categorias de crianças diretamente ligadas a esta categoria.

updated_at
updated_at string

Carimbo de data/hora da última atualização.

criado_em
created_at string

Carimbo de data/hora da criação.

avatar_url
avatar_url string

URL para uma imagem de avatar redimensionada (300x200^).

Devoluções

Body
category

Adicionar uma conta

Adicione uma conta à sua administração.

Parâmetros

Name Chave Necessário Tipo Description
nome
name True string

O nome da conta.

e-mail
email string

Uma cadeia de caracteres que representa o email de cobrança da conta.

id
id integer

Identificador único do endereço.

Destinatário
addressee string

O destinatário do endereço.

address
address True string

Concatenação da rua e número da casa.

código postal
postal_code True string

Uma cadeia de caracteres que representa o código postal.

city
city True string

Uma cadeia de caracteres que representa a cidade.

country
country True string

Uma cadeia de caracteres que representa o país.

updated_at
updated_at string

Carimbo de data/hora da última atualização.

criado_em
created_at string

Carimbo de data/hora da criação.

Devoluções

Body
account

Adicionar uma fatura

Adicione uma fatura à sua administração.

Parâmetros

Name Chave Necessário Tipo Description
Account
account_id True number

Identificador da conta.

account_name
account_name string

O nome da conta que está pagando. É copiado para a fatura e, portanto, não é atualizado automaticamente se o nome da conta mudar.

moeda
currency True string

A moeda da fatura.

id
id integer

Identificador exclusivo do item da fatura.

Units
units True number

O número de unidades do item da fatura.

Description
name True string

O nome do item da fatura.

Preço
unit_price True string

O preço de uma única unidade.

IVA
invoice_vat_id number

Identificador do IVA da fatura.

Variante de catálogo
catalog_variant_id number

Identificador da variante do catálogo.

updated_at
updated_at string

Carimbo de data/hora da última atualização.

criado_em
created_at string

Carimbo de data/hora da criação.

caraterística
feature string

Alguma descrição da fatura que é exibida na fatura.

Nota de rodapé
footnote string

A nota exibida na parte inferior da fatura.

Devoluções

Body
invoice

Excluir uma autenticação de um usuário

Exclua uma das autenticações de um usuário. Observe que você não pode excluir a última autenticação!

Parâmetros

Name Chave Necessário Tipo Description
ID do utilizador
user_id True integer

Identificador do utilizador.

ID de autenticação
authentication_id True integer

Identificador da autenticação.

Listar todas as categorias

Obtenha todas as categorias.

Parâmetros

Name Chave Necessário Tipo Description
Número da página
page integer

Número da página para obter.

Registos por página
per_page integer

Número de registos por página.

Ordenar
sort array

Ordene os resultados. Alterar a ordem usando <sort_by>:[asc|desc]

Devoluções

Listar todas as contas

Obtenha todas as contas.

Parâmetros

Name Chave Necessário Tipo Description
Número da página
page integer

Número da página para obter.

Registos por página
per_page integer

Número de registos por página.

Devoluções

response
array of account

Listar todas as faturas

Obtenha todas as faturas.

Parâmetros

Name Chave Necessário Tipo Description
Número da página
page integer

Número da página para obter.

Registos por página
per_page integer

Número de registos por página.

Devoluções

response
array of invoice

Listar todos os cursos

Obtenha todos os cursos.

Parâmetros

Name Chave Necessário Tipo Description
Número da página
page integer

Número da página para obter.

Registos por página
per_page integer

Número de registos por página.

Ordenar
sort array

Ordene os resultados. Alterar a ordem usando <sort_by>:[asc|desc]

Devoluções

response
array of course

Listar todos os rótulos

Obtenha todos os rótulos.

Parâmetros

Name Chave Necessário Tipo Description
Número da página
page integer

Número da página para obter.

Registos por página
per_page integer

Número de registos por página.

Filtrar por tipo de modelo da etiqueta
model_type string

Filtre etiquetas com base no tipo de modelo.

Devoluções

response
array of label

Listar todos os usuários

Obtenha todos os usuários.

Parâmetros

Name Chave Necessário Tipo Description
Número da página
page integer

Número da página para obter.

Registos por página
per_page integer

Número de registos por página.

Ordenar
sort array

Ordene os resultados. Alterar a ordem usando <sort_by>:[asc|desc]

Devoluções

response
array of user

Listar todos os vats de fatura

Obter todos os vats de fatura

Parâmetros

Name Chave Necessário Tipo Description
Número da página
page integer

Número da página para obter.

Registos por página
per_page integer

Número de registos por página.

Devoluções

Obter as autenticações de um usuário

Obtenha uma lista de autenticações que pertencem a um usuário específico.

Parâmetros

Name Chave Necessário Tipo Description
Número da página
page integer

Número da página para obter.

Registos por página
per_page integer

Número de registos por página.

ID do utilizador
user_id True integer

Identificador do utilizador.

Devoluções

Obtenha todas as variantes do catálogo.

Parâmetros

Name Chave Necessário Tipo Description
Número da página
page integer

Número da página para obter.

Registos por página
per_page integer

Número de registos por página.

Devoluções

Obter um curso

Obtenha um único curso por id

Parâmetros

Name Chave Necessário Tipo Description
ID do curso
id True integer

Identificador do curso.

Devoluções

Body
course

Obter um utilizador

Obtenha um único usuário por id.

Parâmetros

Name Chave Necessário Tipo Description
ID do utilizador
id True integer

Identificador do utilizador.

Devoluções

Body
user

Obter uma categoria

Obter uma categoria por id

Parâmetros

Name Chave Necessário Tipo Description
ID da categoria
id True integer

Identificador da categoria.

Devoluções

Body
category

Obter uma conta

Obtenha uma conta por id.

Parâmetros

Name Chave Necessário Tipo Description
ID da conta
id True integer

Identificador da conta.

Devoluções

Body
account

Obter uma fatura

Obtenha uma única fatura por id.

Parâmetros

Name Chave Necessário Tipo Description
ID da fatura
id True integer

Identificador da fatura.

Devoluções

Body
invoice

Acionadores

Subscrever um webhook

Assine um webhook para ser notificado sobre atualizações de registro.

Subscrever um webhook

Assine um webhook para ser notificado sobre atualizações de registro.

Parâmetros

Name Chave Necessário Tipo Description
id
id string

Identificador exclusivo do webhook. (uma UUID).

active
active boolean

Estado do webhook.

events
events True array of string

Matriz de eventos que devem acionar esse webhook.

Devoluções

Definições

conta

Name Caminho Tipo Description
id
id integer

Identificador único da conta.

nome
name string

O nome da conta.

e-mail
email string

Uma cadeia de caracteres que representa o email de cobrança da conta.

account_type
account_type string

O tipo de conta.

address
address address
phone
phone string

Uma cadeia de caracteres que representa o número de telefone da conta.

updated_at
updated_at string

Carimbo de data/hora da última atualização.

criado_em
created_at string

Carimbo de data/hora da criação.

signup_answers
signup_answers array of customField

Lista de respostas de inscrição para esta conta.

address

Name Caminho Tipo Description
id
id integer

Identificador único do endereço.

Destinatário
addressee string

O destinatário do endereço.

address
address string

Concatenação da rua e número da casa.

código postal
postal_code string

Uma cadeia de caracteres que representa o código postal.

city
city string

Uma cadeia de caracteres que representa a cidade.

country
country string

Uma cadeia de caracteres que representa o país.

updated_at
updated_at string

Carimbo de data/hora da última atualização.

criado_em
created_at string

Carimbo de data/hora da criação.

autenticação

Name Caminho Tipo Description
id
id integer

Identificador exclusivo da autenticação.

user_id
user_id integer

A id do usuário ao qual essa autenticação pertence.

authentication_provider_id
authentication_provider_id integer

A ID do provedor de autenticação.

uid
uid string

O identificador exclusivo dessa autenticação que corresponde a um id exclusivo do IDP.

Se a OTP estiver habilitada para este login.
otp_enabled

Caso o provedor de autenticação seja Eduframe, indica se uma senha está habilitada para este login, é falsa para quaisquer outros provedores.

updated_at
updated_at string

Carimbo de data/hora da última atualização.

criado_em
created_at string

Carimbo de data/hora da criação.

customField

Name Caminho Tipo Description
id
id integer

Identificador exclusivo da resposta de inscrição.

valor
value string

O valor formatado da resposta.

signup_question_id
signup_question_id integer

Identificador único da pergunta.

categoria

Name Caminho Tipo Description
id
id integer

Identificador único da categoria.

Nome
name string

Título da categoria.

Description
description string

A descrição da categoria.

posição
position number

Classificação da posição da categoria. Mais baixo é mais alto.

parent_id
parent_id number

Identificador exclusivo da categoria pai

Avatar
avatar string

URL para o avatar da categoria.

Publicado
is_published boolean

Se a categoria deve ser publicada no site.

courses_count
courses_count number

Número de cursos diretamente ligados a esta categoria.

children_count
children_count number

Número de categorias de crianças diretamente ligadas a esta categoria.

updated_at
updated_at string

Carimbo de data/hora da última atualização.

criado_em
created_at string

Carimbo de data/hora da criação.

avatar_url
avatar_url string

URL para uma imagem de avatar redimensionada (300x200^).

curso

Name Caminho Tipo Description
id
id integer

Identificador único do curso

nome
name string

O nome do curso.

posição
position number

Classificação da posição do curso. Mais baixo é mais alto.

signup_url
signup_url string

URL para a página de inscrição deste curso.

Avatar
avatar string

URL para uma imagem de avatar redimensionada (300x200^).

certificate_template_id
certificate_template_id number

Identificador do modelo de certificado vinculado opcionalmente.

Categoria
category_id number

Identificador da categoria do curso.

código
code string

O código do curso.

custo
cost string

O preço a pagar por este curso.

cost_scheme
cost_scheme string

Como o curso deve ser pago por defeito?

is_published
is_published boolean

Booleano representando o status publicável do curso.

updated_at
updated_at string

Carimbo de data/hora da última atualização.

criado_em
created_at string

Carimbo de data/hora da criação.

utilizador

Name Caminho Tipo Description
id
id integer

Identificador exclusivo do usuário.

Número do funcionário
employee_number string

O número de funcionário deste usuário.

Nome próprio
first_name string

Nome próprio do utilizador.

Nome do meio
middle_name string

Nome do meio do usuário.

Apelido
last_name string

Apelido do utilizador.

Email
email string

O e-mail do usuário.

Número de telefone
phone string

O número de telefone do utilizador.

labels
labels array of label
Subscrever a newsletter
wants_newsletter boolean

O utilizador deseja receber newsletters?

Criar autenticação
with_authentication boolean

Crie uma autenticação para o usuário, de modo que o usuário possa fazer login.

região
locale string

A localidade do usuário.

address
address address
Avatar
avatar_url string

O caminho url relativo para o avatar.

updated_at
updated_at string

Carimbo de data/hora da última atualização.

criado_em
created_at string

Carimbo de data/hora da criação.

factura

Name Caminho Tipo Description
id
id integer

Identificador único da fatura.

reference_id
reference_id string

ID de referência da fatura. É usado para encontrar a fatura.

Account
account_id number

Identificador da conta.

número
number string

O número da fatura que é único por educador. Se deixado vazio, ele é incrementado automaticamente.

number_int
number_int number

O número da fatura convertido em um valor inteiro.

estado
status string

O status da fatura. O status inicial será sempre conceito.

expiration_date
expiration_date string

A data de validade da fatura. É definido quando a fatura está definida para abrir.

opened_at
opened_at string

A data em que o status da fatura foi alterado para abrir.

descrição
description string

Descrição legível por humanos da fatura.

account_name
account_name string

O nome da conta que está pagando. É copiado para a fatura e, portanto, não é atualizado automaticamente se o nome da conta mudar.

moeda
currency string

A moeda da fatura.

total_incl
total_incl string

O custo total da fatura com IVA incluído.

total_excl
total_excl string

O custo total da fatura sem IVA.

total_open
total_open string

O custo em aberto da fatura com IVA incluído.

pdf_url
pdf_url string

URL para o caminho de download da fatura em formato PDF.

xml_url
xml_url string

URL para o caminho de download da fatura no formato UML.

caraterística
feature string

Alguma descrição da fatura que é exibida na fatura.

Nota de rodapé
footnote string

A nota exibida na parte inferior da fatura.

invoice_items
invoice_items array of invoice_item
updated_at
updated_at string

Carimbo de data/hora da última atualização.

criado_em
created_at string

Carimbo de data/hora da criação.

invoice_item

Name Caminho Tipo Description
id
id integer

Identificador exclusivo do item da fatura.

Units
units number

O número de unidades do item da fatura.

Description
name string

O nome do item da fatura.

Preço
unit_price string

O preço de uma única unidade.

IVA
invoice_vat_id number

Identificador do IVA da fatura.

Variante de catálogo
catalog_variant_id number

Identificador da variante do catálogo.

updated_at
updated_at string

Carimbo de data/hora da última atualização.

criado_em
created_at string

Carimbo de data/hora da criação.

invoice_vat

Name Caminho Tipo Description
id
id integer

Identificador único do IVA da fatura.

nome
name string

Nome do IVA da fatura.

percentagem
percentage string

Número que representa a percentagem do IVA.

catalog_variant

Name Caminho Tipo Description
id
id number

Identificador exclusivo da variante do catálogo

product_id
product_id number

Identificador exclusivo do produto do catálogo

nome
name string

O nome do curso.

cost_scheme
cost_scheme string

Como a variante de catálogo deve ser paga por padrão.

custo
cost string

O preço a pagar por esta variante de catálogo.

moeda
currency string

A moeda da variante de catálogo.

variantable_type
variantable_type string

A moeda da fatura.

variantable_id
variantable_id number

Identificador único da variante.

updated_at
updated_at string

Carimbo de data/hora da última atualização.

criado_em
created_at string

Carimbo de data/hora da criação.

Publicado
is_published boolean

Se a categoria deve ser publicada no site.

etiqueta

Name Caminho Tipo Description
id
id number

Identificador único do rótulo

Nome
name string

O nome do rótulo.

Cor
color string

Código hexadecimal da cor do rótulo.

Modelo
model_type string

O tipo de modelo para o qual esta etiqueta é disponibilizada.

updated_at
updated_at string

Carimbo de data/hora da última atualização.

criado_em
created_at string

Carimbo de data/hora da criação.

webhook_payload

Name Caminho Tipo Description
educador
educator string

Lesma do educador.

evento
event string

Tipo de evento que acionou o webhook.

entity_type
entity_type string

Tipo do modelo que acionou o webhook.

entity_id
entity_id number

Identificador exclusivo do modelo que acionou o webhook.

ID do inquilino
tenant_id string

UUID do educador.