Gerenciamento de usuários

Visão geral

Este tutorial aborda o gerenciamento básico de usuários por meio da API do Frame.io.Pressupõe que o leitor já configurou a autenticação via OAuth2.0 ou com um token de desenvolvedor.

Conceitos principais

Deixando de lado as nuances específicas de diferentes funções e permissões de membros da equipe, há duas chaves importantes para entender ao gerenciar usuários por meio da API do Frame.io:

1. Membros da equipe pertencem a equipes e têm acesso a todos os projetos não privados dentro dessas equipes.Gerentes de equipe e administradores são extensões da função de membro da equipe.
2. Colaboradores do projeto pertencem a projetos únicos.Dependendo de como esses projetos são configurados, eles podem ou não conseguir criar apresentações, baixar ativos ou convidar outros colaboradores.

Para mais informações, consulte nossa documentação de suporte para membros da equipe vs. colaboradores e funções de gerenciamento de conta.

Como usuários ingressam em contas

Em geral, novos usuários são convidados por usuários atuais, seja diretamente ou por meio de URL exclusivo de ingresso no projeto.Os membros da equipe também podem:

1. Adicionar-se a projetos não privados dentro de equipes públicas na conta
2. Adicionar-se a equipes públicas dentro da conta
3. Solicitar ingresso em equipes privadas dentro da conta

Em todos os casos, as atividades de ingresso passarão por uma série de etapas lógicas que incluem verificar ocupação anterior, criar registros “pendentes” e enviar emails de convite ou solicitação de ingresso quando apropriado.

A boa notícia é que toda essa lógica é abstraída pela API do Frame.io.Se você quiser adicionar alguém a um projeto, use as rotas de colaborador. Se quiser convidar alguém para uma equipe, use as rotas de membro da equipe.

Escopos obrigatórios

Gerenciar membros da equipe

Adicionar membros da equipe

Para adicionar um novo membro a uma equipe, será necessário:

1. O id da equipe de destino
2. O endereço de email do usuário de destino.

A partir daí, simplesmente faça um POST autorizado para https://api.frame.io/v2/teams/:id/members com o email do usuário de destino no corpo do conteúdo, assim:

1
{
2
    "email": "user@example.com"
3
}

Se o usuário que você convidou já é um membro da equipe na organização, a resposta da API indicará isso:

1
{
2
    "_type": "team_member",
3
    "id": "<team-member-record-id>",
4
    "role": "member",
5
    "team_id": "<team-id>",
6
    "user_id": "<user-id>"
7
}

Se o usuário que você convidou ainda não está na organização, sua solicitação acionará um fluxo de convite, e a resposta da API será mais assim:

1
{
2
    "_type": "pending_team_member",
3
    "email": "user@example.com",
4
    "id": "<oending-team-member-record-id>",
5
    "role": "member",
6
    "team_id": "<team-id>
7
}

Observação: como o usuário ainda não foi criado ou reconhecido, não haverá um user_id mapeável na resposta pending_team_member.

Remover membros da equipe

Para remover um membro de uma equipe, será necessário:

1. O id da equipe de destino
2. O endereço de email do usuário de destino.

Aqui, você fará uma chamada DELETE para o mesmo URL que usaria para adicionar um membro da equipe, passando uma string de consulta especial: DELETE https://api.frame.io/v2/teams/:id/members/_?email=user@example.com

Em uma chamada bem-sucedida, a API retornará um conteúdo útil semelhante à adição de membro da equipe.Se o membro da equipe está sendo excluído pela primeira vez, você verá um atributo updated_at correspondente ao horário da sua chamada.Se o membro da equipe foi excluído anteriormente, esse carimbo de data e hora não será atualizado (ou seja, refletirá o horário quando o membro da equipe foi inicialmente removido).

1
{
2
    "_type": "team_member",
3
    "id": "<team-member-record-id>",
4
    "role": "member",
5
    "team_id": "<team-id>",
6
    "user_id": "<user-id>",
7
    "updated_at": "<timestamp>"
8
}

Tentativas de remover membros da equipe que não existem ou nunca foram associados à equipe resultarão em erros 404.

Gerenciar colaboradores do projeto

Adicionar colaboradores ao projeto

O gerenciamento de colaborador é extremamente semelhante ao gerenciamento de membros da equipe.Para adicionar um novo colaborador a uma equipe, será necessário:

1. O id do projeto de destino
2. O endereço de email do usuário de destino.

A partir daí, faça um POST autorizado para https://api.frame.io/v2/projects/:id/collaborators, com o email do usuário de destino no corpo do conteúdo:

1
{
2
    "email": "user@example.com"
3
}

Se o usuário que você convidou é reconhecido e a função de colaborador pode ser instanciada instantaneamente, a resposta da API indicará isso e enviará de volta um objeto User completo:

1
{
2
    "_type": "collaborator",
3
    "creator_id": "<inviting-user-id>",
4
    "id": "<collaborator-record-id>",
5
    "project_id": "<project-id>",
6
    "user": {
7
        "_type": "user",
8
       <...>
9
    },
10
    "user_id": "<user-id>"
11
}

Se o usuário convidado for novo na organização, sua solicitação acionará um fluxo de convite, e a API responderá com um registro pending_collaborator, assim:

1
{
2
    "_type": "pending_collaborator",
3
    "email": "user@example.com",
4
    "id": "<pending-collaborator-record-id>",
5
    "project_id": "<project-id>"
6
}

Remover colaboradores do projeto

Observação: este processo é fundamentalmente idêntico ao modo como os membros da equipe são tratados (acima).

Para remover um colaborador de um projeto, será necessário:

1. O id do projeto de destino.
2. O endereço de email do usuário de destino.

Aqui, você fará uma chamada DELETE para o mesmo URL que usaria para adicionar um colaborador, passando uma string de consulta especial.DELETE https://api.frame.io/v2/projects/:id/collaborators/_?email=user@example.com

Em uma chamada bem-sucedida, a API retornará um conteúdo semelhante à adição de colaborador do projeto.:

1
{
2
    "_type": "collaborator",
3
    "creator_id": "<inviting-user-id>",
4
    "id": "<collaborator-record-id>",
5
    "project_id": "<project-id>",
6
    "user": {
7
        "_type": "user",
8
       <...>
9
    },
10
    "user_id": "<user-id>"
11
}

Tentativas de remover colaboradores que não existem ou nunca foram associados ao projeto resultarão em erros 404.