Como gerar credenciais da API na Agenda Edu?

A API da Agenda Edu permite que escolas e parceiros integrem sistemas de forma segura e automatizada. Para isso, é necessário gerar credenciais de acesso. As credenciais são compostas por três informações:
  • cliente_id

  • secret_key

  • x_school_token
     

Siga o passo a passo abaixo para gerar suas credenciais:

1. Acesse seu perfil
  1. No canto superior direito da tela inicial, clique no seu nome/ícone.

  2. No menu suspenso, selecione “Meu perfil”.

    Captura de Tela 2025-09-10 às 12.33.26.png

     

:câmera_com_flash: Exemplo: 2. Vá até a aba de API
  1. No menu superior, clique na aba API.

  2. Clique em “Nova Credencial”.

    Captura de Tela 2025-09-10 às 12.36.14 (1).png

     

:câmera_com_flash: Exemplo:3. Crie uma nova credencial
  1. Insira um nome para a credencial (ex.: Token para leitura de dados).

  2. Clique em Salvar.

    Captura de Tela 2025-09-10 às 12.37.56.png

     

:câmera_com_flash: Exemplo: 4. Copie as informações geradas. Após salvar, o sistema exibirá os dados:
  • cliente_id (UID) → localizado na lista de tokens criados.

  • secret_key → exibida no topo da tela após a criação da credencial.

  • x_school_token (Token da Escola) → disponível no campo “Token da Escola”.

    Captura de Tela 2025-09-10 às 12.38.26.png

:atenção: Importante:
  • Guarde suas credenciais em local seguro.

  • Não compartilhe com terceiros sem autorização, pois elas permitem acesso às informações da escola.

     

5. Uso das credenciais:

Com as credenciais em mãos, você poderá utilizá-las nas integrações com a Agenda Edu:
  • cliente_id: identifica sua credencial no sistema.

  • secret_key: funciona como senha de autenticação.

  • x_school_token: identifica a escola que está sendo integrada.
     

:apontando_para_a_direita: Pronto! Agora você já sabe como gerar e utilizar suas credenciais de API na Agenda Edu.


Ficou com dúvidas?! Fale com nosso Suporte através de um dos nossos canais: 

Se você estiver usando a plataforma web, é só tocar no chat do lado direito da tela ou, se estiver usando o aplicativo, é só clicar no balão roxo com ícone de "ponto de interrogação '?'", se preferir, fale pelo e-mail: atendimento@agendaedu.com, e ainda pelo nosso WhatsApp (11) 4040.2998 💜 

Esse artigo foi útil?

Usuários que acharam isso útil: 0 de 0

Tem mais dúvidas? Envie uma solicitação

Comentários

0 comentário

Por favor, entre para comentar.