Passar para o conteúdo principal

API da Teachworks

Escrito por Teachworks Support

A API da Teachworks é uma interface de programação de aplicativos que permite acessar os dados da sua conta Teachworks para desenvolver integrações e softwares personalizados.

NOTA: O acesso à API está disponível apenas para empresas com as assinaturas "Growth" e "Premium".

Habilitando a API

  1. Clique em "Conta" e depois em "Integrações e complementos".

  2. Utilize o campo "Pesquisar" na parte superior e digite "API".

  3. Ative a opção "Ligado" para habilitar a API.

Uso

Após ativar a API, clique no link "Configurações". Você pode gerar seu token da API Teachworks clicando no botão "Gerar Token da API".

Você usará essa chave para acessar sua conta por meio da API. Proteja-a como uma senha e não a inclua em nenhuma página da web pública (ela deve ser usada no servidor para páginas da web voltadas para o público).

Você também pode clicar no botão "Criar conta de teste" se desejar criar uma conta de teste para testar a integração da sua API antes de conectá-la à conta de produção da sua empresa.

Documentação da API

Você pode encontrar a documentação da nossa API aqui: Documentação da API da Teachworks. Adicionaremos endpoints adicionais à API para acessar outros tipos de dados e gerenciar registros.

Se você estiver interessado em um endpoint que não esteja disponível no momento, entre em contato conosco pelo endereço support@teachworks.com e analisaremos a possibilidade de adicioná-lo.

Respondeu à sua pergunta?