Como podemos te ajudar hoje?

API de gerenciamento

Você está aqui:
< Voltar

Gerenciando compartilhamentos e permissões por meio da API pública do MyWorkDrive

(v7.1+)

A versão 7.1 do MyWorkDrive apresenta uma nova e poderosa API pública que permite aos administradores automatizar a criação, configuração e remoção de compartilhamentos de arquivos e permissões usando solicitações HTTP. Esta API foi projetada para usuários avançados que precisam integrar o gerenciamento de compartilhamentos em sistemas e scripts externos., ou fluxos de trabalho de orquestração.

Começando

1. Habilite a API
Vá para Painel de Administração > Empresarial
Habilitar a API pública
Copie sua chave de API

Todas as solicitações devem incluir a chave da API no cabeçalho HTTP:
Cabeçalho: Chave de API: {seu-API-chave}

2. Acesse a API
API é hospedado localmente (por padrão) em:
http://127.0.0.1:8360

Pontos de extremidade de gerenciamento de compartilhamento

Operação

Método

Ponto final

Notas

Lista todas as ações

PEGAR

/API/v3/ListShares

Retorna uma matriz de todas as ações

Obtenha uma ação pelo nome

PEGAR

/API/v3/ObterCompartilhar?nome={Nome do compartilhamento}

Retorna a ação se existir

Criar um novo compartilhamento

PEGAR

/api/v3/CreateShare?name={nome}&path={caminho}&storageProviderId={id}

Requer ID do provedor de armazenamento

Excluir um compartilhamento

PEGAR

/API/v3/ExcluirCompartilhar?nome={nome}

NÃO remove permissões automaticamente

Nota: Os compartilhamentos só aparecerão no Painel de Administração se pelo menos
uma permissão é atribuída. As alterações na API podem levar até 5 minutos para serem refletidas devido
para armazenamento em cache.

Pontos de extremidade de gerenciamento de permissões

Operação

Método

Ponto final

Notas

Listar todas as permissões

PEGAR

/API/v3/Listar Permissões

Lista todas as entradas

Listar permissões para usuário/grupo

PEGAR

/API/v3/ListPermissions?nome={nome}

Filtros por nome

Permissão de criação/atualização

PEGAR

/API/v3/Permissão de lugar?…

Veja abaixo

Permissão de exclusão

PEGAR

/API/v3/ExcluirPermissão?…

Todos os campos são obrigatórios

Permissão de lugar Parâmetros

Parâmetro

Tipo

Obrigatório

Descrição

nome

corda

Usuário ou
Nome do grupo

nome de domínio

corda


para usuários
opcional para grupos no modo Entra ID

Usar vazio
string para grupos de ID Entra

Nome do compartilhamento

corda

Nome do
compartilhar

éGrupo

booleano

verdade para
grupos

webClientAllowed

booleano

Habilitar web
acesso do cliente

desktopClientAllowed

booleano

Habilitar
acesso à unidade mapeada (área de trabalho)

mobileClientAllowed

booleano

Habilitar
acesso ao aplicativo móvel

Compartilhamento público habilitado

booleano

Permitir público
compartilhamento de links

dlpDownloadHabilitado

booleano

Permitir arquivo
baixar (se DLP estiver habilitado)

dlpOfficeOnlineEditHabilitado

booleano

Permitir Office
Edição somente online

Exemplo (para o Grupo Entra ID):
GET /api/v3/PlacePermission?name=All%20Entra%20ID%20Members&shareName=LocalTest&domainName=&isGroup=true&webClientAllowed=true&desktopClientAllowed=true&mobileClientAllowed=true&publicSharingEnabled=true&dlpDownloadEnabled=true&dlpOfficeOnlineEditEnabled=true

Provedores de armazenamento

Para criar um compartilhamento, você precisa do ID do provedor de armazenamento.

Como recuperá-lo:
1. Acesse Painel de Administração > Integrações
2. Crie uma nova entrada de armazenamento (por exemplo, Azure Blob, Azure Files, SMB)
3. Verifique o arquivo General.xml em Wanpath\wanpath.dados\configurações
para o gerado ID do provedor de armazenamento

⚠️ Atualmente, suporte de API para gerenciamento de armazenamento
provedores (adicionar/remover) está sob consideração.

Notas e Limitações

• Atraso de cache: as atualizações podem levar até 5 minutos para aparecer
o Painel de Administração.
• Comportamento de exclusão: a exclusão de um compartilhamento NÃO exclui automaticamente os associados
permissões (deve ser feito como uma postagem separada).
• Verbos HTTP: A API é independente de verbos (GET, POST, etc.), mas os exemplos aqui usam
GET para simplificar.
• Espaços e codificação: os parâmetros de URL devem ser codificados por URL (por exemplo, todos os IDs de entrada
Members → All%20Entra%20ID%20Members).
• Modificações: Para modificar um compartilhamento ou permissão, exclua-o e recrie-o.

Considerações de segurança

Esta API foi projetada para ser executada em uma interface de rede local privada por padrão. Torná-la acessível publicamente deve ser feito com extremo cuidado. Por segurança, a API de Gerenciamento é hospedada em um site IIS separado. Wanpath.Admin.API na porta 8360. Para segurança adicional, adicione um nome de host e um certificado SSL a este site do IIS, continuando a limitar o acesso via firewall ou controles de autenticação.