Quando um ERP, o sistema do seu contador ou uma ferramenta contratada vai se integrar à Kamino, quem escreve o código precisa da referência da API. Essa pessoa quase nunca é usuária da plataforma — e não deveria virar uma só para ler a documentação.
O passe de documentação resolve exatamente isso.
Onde fica o acesso à documentação da API
Em Configurações, no grupo Integrações, item Acesso à documentação, na plataforma web.
Enquanto ninguém de fora tiver acesso, a tela mostra Ninguém de fora tem acesso à documentação e o botão Liberar o primeiro acesso. Depois disso, o botão Liberar acesso fica no alto da tela, ao lado de Abrir documentação.
Quem pode liberar o passe de documentação
Só quem administra o acesso da conta emite ou revoga o passe de documentação. Quem não tem essa permissão vê o aviso Você não vê os acessos à documentação.
A opção Sem prazo aparece só para quem tem a permissão Emitir passe de documentação permanente e só quando a Kamino liberou o passe sem prazo para a sua conta. Em Papéis e permissões, ela é a funcionalidade Passe permanente, no bloco Leitores da documentação da API. Entre os papéis padrão, ela vem só com Administrador da Organização e Administrador.
Como liberar o acesso à documentação da API
O painel se chama Liberar acesso à documentação e pede quatro coisas — duas obrigatórias, o prazo e uma opcional.
E-mail do desenvolvedor — o convite chega neste endereço, com o link de acesso.
Integração — qual integração este acesso serve, escolhida entre as integrações desta conta. É o que permite, meses depois, saber por que aquele passe existe. Se a integração ainda não tem chave de API, escolha Outra — ainda sem chave e dê um nome a ela.
Prazo do acesso — 7 dias, 30 dias (padrão) ou 90 dias. Quem tem a permissão para isso vê também Sem prazo, para um passe que vale até alguém revogar.
Observação (opcional) — por que este acesso existe. Aparece na lista e na trilha de auditoria.
Ao final, Enviar convite.
O que o passe de documentação abre — e o que não abre
O passe de documentação costuma gerar dúvida em quem aprova o acesso, e a resposta é curta: o passe abre só a referência da API.
O próprio painel declara: "A pessoa lê a documentação da API. Ela não abre telas nem vê dados desta conta." A pessoa entra com o papel Desenvolvedor, que só lê a referência: ele não concede permissão sobre lançamentos e não expõe saldo, cadastro ou histórico.
Quem tem só o passe, ao entrar na Kamino, vai direto para a documentação da API.
Quem já é usuário não precisa de passe de documentação
Quem já é usuário desta conta entra na documentação com a própria sessão. Se você tentar liberar o acesso para o e-mail de um usuário, a Kamino recusa e diz que o acesso dele à documentação se ajusta no perfil, na tela de pessoas.
Regras, prazos e limites do passe de documentação
Prazo de 7, 30 ou 90 dias. O padrão é 30 dias. O prazo é da Kamino e existe para que o acesso termine sozinho. Sem prazo vale até alguém revogar.
Cada passe é de um e-mail só. O passe pertence a uma conta e a um endereço de e-mail.
Liberar de novo para quem tem passe vigente renova o passe. O pedido novo aplica o prazo, o nome e a observação que você escolher agora.
Nome da integração com 2 a 80 caracteres, quando você escolhe Outra — ainda sem chave.
Observação com até 200 caracteres.
Revogar vale na hora. A pessoa perde o acesso na tentativa seguinte de abrir a documentação.
Passe vencido ou revogado não volta a valer. Para devolver o acesso, a Kamino emite um passe novo.
Convite que não chegou não invalida o passe. O passe continua vigente, e a lista oferece Reenviar convite.
Prazo e rastreabilidade do passe de documentação
O prazo existe para que o acesso termine sozinho. Uma integração que levou três meses para ficar pronta não precisa deixar uma porta aberta para sempre. O padrão de 30 dias cobre a maior parte dos casos, e 90 dias fica para projetos mais longos.
Um passe vencido não precisa ser revogado — ele já não abre nada, e por isso só o passe vigente oferece Revogar. Para devolver o acesso a quem perdeu, use Reemitir passe, na linha do passe vencido. Ele emite um passe novo para o mesmo e-mail, válido por 30 dias, com o mesmo nome e a mesma observação.
Cada passe aparece na lista desta tela e na trilha de auditoria, junto com a observação que você escreveu. É assim que se responde, mais adiante, quem liberou aquele acesso e por quê.
Situação de cada passe na lista de acesso à documentação
A lista mostra, por passe, quem emitiu, o vencimento, o último uso e a situação:
Vigente — o passe abre a documentação. Se o e-mail não chegou, aparece Convite não entregue, com o botão Reenviar convite.
Vencido — o prazo terminou. A linha oferece Reemitir passe.
Revogado — alguém revogou o passe. Ele não volta a valer.
A coluna Último uso mostra Nunca usado quando ninguém abriu a documentação com o passe.
Por que o passe de documentação não foi emitido, e o que fazer
O painel continua aberto com o que você preencheu, e o motivo aparece no próprio painel.
Esta pessoa já é usuária desta conta. O e-mail já é de um usuário. Clique em Abrir pessoas e ajuste o acesso dele à documentação no perfil.
Informe um e-mail válido. Confira o endereço digitado em E-mail do desenvolvedor.
Escolha a integração deste passe. Escolha uma integração na lista, ou Outra — ainda sem chave.
Dê um nome para reconhecer este passe na lista. Em Outra — ainda sem chave, escreva o nome da integração.
Use de 2 a 80 caracteres. O nome da integração está curto ou longo demais.
A observação aceita até 200 caracteres. Encurte a observação.
Emissão não confirmada. A Kamino não confirmou se o passe foi criado. Confira a lista antes de tentar de novo.
Não foi possível emitir o passe. A Kamino recusou a emissão. O motivo vem logo abaixo do título.
Perguntas frequentes sobre o passe de documentação
Como dou acesso à documentação da API para o desenvolvedor do meu ERP?
Abra Configurações › Integrações › Acesso à documentação e clique em Liberar acesso. Informe o e-mail do desenvolvedor, a integração e o prazo, e clique em Enviar convite.
O desenvolvedor com o passe vê os dados da minha empresa?
Não. O passe abre só a referência da API. Ele não abre telas do produto nem mostra saldo, cadastro ou histórico.
O passe venceu. Como devolvo o acesso?
Na linha do passe vencido, clique em Reemitir passe. A Kamino emite um passe novo, válido por 30 dias, com o mesmo nome e a mesma observação.
O desenvolvedor não recebeu o convite. O que faço?
Quando o e-mail não chega, a linha do passe mostra Convite não entregue. Clique em Reenviar convite. O passe continua vigente enquanto isso.
Como tiro o acesso de quem tem o passe?
Clique em Revogar, no menu da linha do passe vigente, e confirme em Revogar passe. O passe para de funcionar na hora, e a revogação fica na trilha de auditoria.
Dá para liberar a documentação sem prazo?
Dá, para quem tem a permissão Emitir passe de documentação permanente e cuja conta tem o passe sem prazo liberado pela Kamino. Essa pessoa vê a opção Sem prazo, e o passe vale até alguém revogar.