Passar para o conteúdo principal

Chamada API para cursos

🦉 Documentação da API Easy LMS ✓ Cursos ✓ Linguagem da API ✓ Adicionar participante

Com a nossa API simples, pode adicionar automaticamente participantes aos seus cursos e enviar-lhes um convite.

Linguagem da API

A nossa API aceita application/x-www-form-urlencoded ou multipart/form-data e json.

API do Curso

Adicionar participante

Esta chamada à API destina-se a cursos que são apenas por convite.

Método HTTP: POST

É necessário introduzir o ID do curso no URL do ponto final em vez de {COURSE_ID}. Pode encontrar este ID no Painel de controlo > Cursos > Curso > Integrações > API.

Cabeçalhos:

: application/jsonX-Api-Key: Segredo da chave da API

O segredo da chave da API pode ser gerado (ou regenerado) em Minha conta > Configuração avançada > Acesso à API. Certifique-se de que guarda o segredo da chave da API num local seguro. Depois de sair (ou atualizar) a página, NÃO voltará a ser mostrado por razões de segurança!

Conteúdo:

{ "name": "Participante", "email": "[email protected]"}``` | Basta introduzir o nome e o endereço de correio eletrónico do participante que pretende adicionar.   **Resposta de sucesso:** ```{ "status": "ok", "participant": {"name": "Participante", "email": "[email protected]", "uuid": "4f59ba19-fd70-43f8-bcb2-3b2eb5bd1234" }}

Exemplo de resposta de erro:

{ "name": "Conflito", "mensagem": "Entrada duplicada", "código": 0, "status": 409}

Se um participante já tiver sido adicionado a um curso, a API não falhará, mas actualizará os dados do participante se o identificador for o mesmo.

Respondeu à sua pergunta?