Pular para o conteúdo

Equipe e acesso

Convide alguém para toda a conta do lojista ou para uma única loja. Use uma sessão de login com acesso de proprietário do lojista; uma chave de API da loja não pode gerenciar a equipe. Para compartilhar toda a sua conta Invoise, com carteira e cartão, adicione um membro da conta.

Janela do terminal
curl -X POST 'https://platform.invoise.me/api/v1/merchants/{merchant_id}/invites' \
-H 'Authorization: Bearer <session-token>' \
-H 'Idempotency-Key: <saved-unique-key>' \
-H 'Content-Type: application/json' \
-d '{"provider":"email","subject":"[email protected]","role":"developer","shop_id":"<shop-id>"}'

Use viewer para leitura, developer para trabalho de integração, ou owner para administração. Defina shop_id para limitar o convite a uma loja. Omiti-lo ou defini-lo como null concede acesso a todo o lojista.

Para convidar um agente ou alguém que entra com uma carteira, envie "provider":"wallet" com o endereço EVM dele como subject. Ele aceita depois de entrar com essa carteira.

Verifique a função e o escopo antes de enviar. A loja selecionada deve estar ativa e pertencer a esse lojista; uma loja inválida não recai para acesso a todo o lojista.

O destinatário entra e aceita com POST /api/v1/invites/{id}/accept. Envie uma chave de idempotência nessa requisição também. Antes de aceitar, GET /api/v1/invites/{id} mostra o lojista, a loja, o papel e quem convidou, com status open, accepted, used, revoked, expired ou unavailable. Um convite fica aberto por 7 dias por padrão.

Por padrão, um lojista pode ter até 10 membros e convites pendentes juntos. Além disso, tanto convidar quanto aceitar retornam 400 team_limit_reached; a equipe do Invoise pode aumentar o limite. Veja Limites.

Requisição Finalidade
GET /api/v1/merchants/{merchant_id}/team lista concessões e convites.
DELETE /api/v1/merchants/{merchant_id}/invites/{id} revoga um convite pendente.
DELETE /api/v1/merchants/{merchant_id}/grants/{id} remove um acesso existente.
POST /api/v1/merchants/{merchant_id}/leave sair de um lojista em que você entrou.

As alterações exigem a sessão de proprietário apropriada e uma chave de idempotência. Se o MFA estiver ativado, uma operação sensível pode pedir um código recente.

Para sair basta a sua própria sessão. É recusado para o lojista que você criou (own_merchant), para o último proprietário dele (last_merchant_owner) e enquanto uma das lojas dele repassar para a sua carteira Invoise (wallet_in_use, com os nomes das lojas em error.details).

Um membro da conta trabalha em toda a sua conta Invoise: carteira, cartão, indicações e todos os lojistas que você possui. Um membro da equipe das seções acima recebe um papel em um lojista ou em uma loja e nunca vê sua carteira nem seu cartão. Os membros da conta são gerenciados no painel, em Perfil → Acesso.

Papel Pode
Leitor (viewer) Ver a carteira, o cartão, as indicações e seus lojistas. Não altera nada.
Editor (editor) O mesmo que um leitor, e trabalhar nas lojas como developer: faturas, endereços, chaves de API, webhooks. As configurações das lojas ficam com o proprietário.
Proprietário (owner) Tudo o que você pode: sacar, alterar a proteção da carteira e os saques automáticos, o cartão, as configurações das lojas e os membros da conta.

Um leitor ou editor nunca saca, assina, altera a proteção da carteira, emite ou fecha o cartão nem gerencia membros. Um coproprietário ainda precisa do código, da senha ou da chave de recuperação da carteira para assinar, mas dê esse papel só a alguém em quem você confia como em si mesmo. Se a sua conta tem 2FA, um membro confirma alterações sensíveis com um segundo fator próprio, então ele também precisa de 2FA (403 account_mfa_required).

Em Perfil → Acesso clique em Convidar, informe um e-mail e escolha um papel. O convite vale por 7 dias; convidar o mesmo e-mail de novo o renova e muda o papel. Uma conta pode ter até 20 membros e convites juntos.

Só pode aceitar um usuário que comprovou esse e-mail: entrando com um código enviado a ele ou com uma conta Google cujo e-mail o Google verificou. Um e-mail digitado no cadastro com carteira só conta depois do primeiro login com um código enviado a ele. O convidado encontra o convite nas notificações e em Perfil → Acesso → Convites e clica em Aceitar ou Recusar; quem não tem conta Invoise o recebe por e-mail. Um membro não precisa de um lojista próprio.

As contas compartilhadas com você ficam no menu da conta, em Contas, e Minha conta traz você de volta. Cada página de uma conta alheia mostra uma barra com a conta, seu papel e Voltar para minha conta. Perfil → Acesso → Compartilhadas com você também as lista, com Abrir e um botão para sair da conta. Se a conta do proprietário for bloqueada ou excluída, os membros perdem o acesso.

O proprietário muda o papel de um membro ou clica em Remover acesso, ou em Revogar convite para um convite pendente. Quando um membro sai ou é removido, as chaves de API que ele criou nas suas lojas são revogadas; o mesmo acontece quando o papel dele passa a Leitor. Você recebe um aviso de segurança a cada alteração: verifique o que o membro pode ter configurado, como webhooks, membros da equipe, o delegado e os saques automáticos.

O painel faz estas requisições com a sua sessão; uma chave de API da loja não pode usá-las.

Requisição Finalidade
GET /api/v1/account/members lista membros e convites, com status pending, active ou expired.
POST /api/v1/account/members convidar: {"email":"[email protected]","role":"viewer"}.
PATCH /api/v1/account/members/{id} alterar o papel: {"role":"editor"}.
DELETE /api/v1/account/members/{id} revogar um convite ou remover um membro.
GET /api/v1/accounts contas das quais você é membro e convites para você.
POST /api/v1/accounts/invites/{id}/accept aceitar um convite.
DELETE /api/v1/accounts/invites/{id} recusar um convite.
DELETE /api/v1/accounts/{owner_id} sair de uma conta.

Para agir na conta de outra pessoa, envie X-Invoise-Account: <owner_id>, o id de GET /api/v1/accounts; com ele, um coproprietário também gerencia os membros dessa conta. O fluxo de eventos GET /api/v1/live e os downloads export.csv, que não podem levar um cabeçalho, aceitam ?account=<owner_id> no lugar. Seu próprio perfil, login, notificações e participações o ignoram. Uma requisição fora do seu papel retorna 403 com account_access_denied, account_read_only ou account_owner_only. Erros de convite retornam 400: invalid_email, invalid_role, account_invite_self, account_member_exists, account_member_limit, account_member_not_found, invite_unavailable.

Se a equipe do Invoise bloquear um lojista, suas faturas não pagas são canceladas com o motivo merchant_blocked, seus endereços de depósito são desativados e suas chaves de API param de funcionar. Os membros veem o motivo no painel.

Um usuário bloqueado ainda pode entrar, ver a carteira, o cartão e as notificações, sacar da carteira e fechar o cartão. As demais requisições retornam 403 account_disabled com o motivo em error.details.

O Invoise envia avisos de conta, pagamentos e segurança, como pagamentos recebidos, saques da carteira, mudanças de segurança, operações com o cartão e convites, por e-mail e, quando você o conecta, pelo Telegram. Escolha os canais no seu perfil.

Baixe GET /api/v1/shops/{shop_id}/export.csv com acesso de leitura da loja. Use-o para exportações de contabilidade, não como uma notificação de pagamento.