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.

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.

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.

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.

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.

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.

As requisições de um usuário bloqueado, exceto as de carteira e cartão, retornam 403 account_disabled com o motivo em error.details.

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.