Objetivo, alcance e limitações:
Este artigo tem como objetivo explicar como integrar-se ao Buk Capacitaciones através de sua API. Seu escopo inclui a obtenção de uma API Key, o acesso à documentação e uma visão geral dos recursos disponíveis. Não abrange detalhes de desenvolvimento avançado nem configurações personalizadas fora da documentação oficial.
🧠 Antes de começar, o que é uma API?
UmaAPI (Application Programming Interface)é um conjunto de regras que permite que diferentes sistemas de software se comuniquem entre si de maneira segura e estruturada. Você pode imaginá-la como uma ponte que conecta distintas aplicações para compartilhar informação automaticamente, sem necessidade de intervenção manual.
🤝 O módulo de Capacitaciones possui API disponível?
Sim. No Buk Capacitaciones incentivamos a integração com outros sistemas, por isso contamos com umaAPI pública e documentada. Isso permitirá:
- Exportar informações do Buk Capacitaciones.
- Injetar dados de outros sistemas externos (por exemplo, ERP ou CRMs).
- Automatizar processos e manter plataformas sincronizadas.
🔐 Como acessar a API do módulo de Capacitaciones?
Para começar, você precisará gerar uma chave de acesso (API Key). Essa chave permite identificá-lo e proteger a comunicação entre sistemas.
Passos para obter sua API Key:
- Acesse as configurações gerais (ícone de engrenagem)
- Selecione a opção“Acessos API”.
- A partir daí você pode:
- Gerar uma nova chave.
- Consultar chaves existentes para usá-las em suas integrações.
- Gerar uma nova chave.
📚 Onde encontro a documentação da API?
Agora que você já tem suakeyde acesso, você deve acessar a documentação da API. A documentação é pública e você pode acessá-la através da URL da empresa seguida por/capacitaciones/docs. Por exemplo, se sua empresa se chama superdemo e você usa o domínio “boostworld.com”, a URL seria https://superdemo.boostworld.com/capacitaciones/docs. Por outro lado, se sua empresa for Buk e você usar o domínio “buk.cl”, a URL seriahttps://buk.buk.cl/capacitaciones/docs.
Uma vez na documentação, você pode testar a API ao vivo autenticando-se através do botão Authorize.
Depois, mais abaixo, você pode ver todos os endpoints ou métodos que pode utilizar em nosso sistema.
Por fim, para testar ao vivo, você pode clicar em um dos endpoints e, ao clicar em “Try it out”, o sistema habilitará a opção de testar o endpoint.
Lá você pode configurar os diferentes parâmetros que a API pode receber (você pode deixá-los em branco e ela usará valores padrão), clicar em “Execute” para testar o endpoint.
Com isso você poderá obter a resposta que o endpoint da API retornará.
Aproveite dados automáticos!!
A partir de agora, você já pode fazer uso da nossa API e assim ter todos os seus sistemas conectados e sincronizados automaticamente!
🧩 Anexo: Lista de Endpoints
|
CustomCategory GET /capacitaciones/api/categories/{id}/entities Retorna as entidades associadas às opções de categoria de uma categoria específica. |
Qué dato es? Considerando o id de uma categoría customizada, recupera todas as opções associadas a essa categoría.Por cada opción se muestra:
|
|
CustomCategory GET /capacitaciones/api/custom_categories Recupera a coleção de recursos CustomCategory. |
Recupera todas as categorias customizadas existentes para este tenant. São exibidas as seguintes informações por categoria:
|
Lembre-se, se precisar de ajuda você pode nos contatar através dos nossos canais de atendimento.
Chat | Telefone | E-mail.
Ficamos felizes em ajudar!
🤖 Este artigo foi traduzido com inteligência artificial. Ver artigo original.