Contas e planos

A API do Mokxi

Tokens para scripts, CI e plugins de editor: como criar um, o que cada escopo permite e os limites de cada plano.

Para que serve

A API permite que um código faça o que você faz no editor: listar seus projetos, ler e escrever os arquivos deles e rodar um circuito para ver se ele se comporta. As pessoas usam para testar um sketch a cada push com uma GitHub Action, manter o código no próprio editor enquanto o circuito roda no Mokxi e automatizar as partes chatas.

Everything is on the página de desenvolvedores: um início rápido, os limites de cada plano, os códigos de erro e todas as rotas.

Criando um token

Abra Configurações no rodapé da barra lateral do editor e escolha Tokens de API. Dê ao token um nome que você reconheça depois, marque as permissões de que ele precisa e escolha quando expira.

  • projects:read lê seus projetos e os arquivos deles.
  • projects:write cria, altera e exclui projetos.
  • simulate roda circuitos.

O token é mostrado uma única vez, logo depois que você o cria. Copie-o nesse momento: o Mokxi guarda apenas uma cópia embaralhada e não pode mostrá-lo de novo. Se você o perder, revogue e crie outro.

Entrando de uma ferramenta

The Mokxi CLI and editor plugins do not need a pasted token. They show you a short code and open mokxi.com/device. Confira o nome da ferramenta e o que ela pede, depois aprove. Ela recebe um token próprio, que aparece na sua lista como qualquer outro.

Só aprove um código que você mesmo iniciou, agora há pouco.

Revogando

Cada token aparece listado em Developer, com quando foi usado pela última vez e quanto fez neste mês. Revogar o interrompe na hora, onde estiver.

Limites

Cada plano tem seus próprios limites de requisições por minuto, simulações por hora e por quanto tempo uma simulação pode rodar:

Grátis Pro e todos os outros planos pagos
Requisições por minuto, por token 60 600
Simulações por hora, por token 30 600
Tempo simulado em uma rodada 10 segundos 60 segundos
Tokens ativos por conta 5 25

A tabela completa está na página para desenvolvedores.

Minutos de simulação por mês

As simulações também contam para uma cota mensal de tempo simulado, somada em todos os seus tokens:

  • Grátis: 100 minutos por mês.
  • Pro e Estudante: 2.000 minutos por mês.
  • Ultra (não é mais vendido; contas que o têm continuam com ele): 5.000 minutos por mês.
  • Sala de aula (e o plano Professor, descontinuado): 2.000 minutos por mês, compartilhados pela turma. As rodadas do professor e as rodadas dos alunos nas turmas pagas do professor contam para o mesmo total.
  • Escolas e universidades: podemos definir um número maior para você. Fale com a gente em mokxi.com/schools/quote.

A contagem reinicia à meia-noite UTC do primeiro dia de cada mês. Uma simulação que começa antes de você atingir o limite sempre termina. Quando o limite é atingido, novas simulações são recusadas até o primeiro dia do mês seguinte, com uma mensagem avisando isso. Você nunca é cobrado por passar do limite.

O Developer nas Configurações mostra quantos minutos você usou neste mês, quando a contagem reinicia e se o total é compartilhado com sua turma.