Mergin Maps

Aparência

Cliente da API do Python ​

Quer integrar Mergin Maps? Mergin Maps é uma plataforma aberta que se destina a ser fácil de utilizar para os programadores e foi concebida para permitir uma integração fácil com outro software.

Galeria de exemplos do Jupyter Notebooks disponível

Mergin Maps Cliente Python O repositório disponibiliza exemplos de código curtos sobre como utilizar o módulo cliente Python em cenários básicos, tais como a gestão de utilizadores, a sincronização ou a gestão de projetos.

Instalação ​

O módulo cliente Python é a forma mais fácil de utilizar programaticamente Mergin Maps. Pode utilizar a API do Python ou uma ferramenta de linha de comandos para trabalhar facilmente com os seus projetos, por exemplo, para obter o estado do projeto, enviar e receber alterações. Também pode criar contas de utilizador e gerir as suas funções.

O cliente Python está disponível no repositório PyPI e pode ser instalado com pip:

pip3 install mergin-client

Interface de linha de comandos ​

Para quem prefere utilizar o terminal, existe fusão ferramenta de linha de comandos incluída no cliente Python. Com vários comandos integrados, é possível descarregar Mergin Maps projetos, enviar/receber alterações, criar ou eliminar projetos e muito mais.

Por exemplo, para descarregar um Mergin Maps projeto para uma pasta local:

mergin download john/project1 ~/mergin/project1

Para mais informações, visite MerginMaps/python-api-client.

Módulo Python ​

Para utilizar Mergin Maps em Python, basta criar MerginClient objeto e, em seguida, utilizá-lo. Aqui, por exemplo, para descarregar um projeto:

python
importar mergin

cliente = mergin.MerginClient(login='john', password='T0p_secret')
client.download_project('lutraconsulting/Inquérito básico', '/tmp/basic-survey')

Se tiver instalado o pluginMergin Maps QGIS e quiser utilizá-lo a partir da consola Python do QGIS

python
importar Mergin.mergin como mergin
cliente = mergin.MerginClient(login='john', password='T0p_secret')

Referência da API - utilizadores ​

Pode criar novos utilizadores e gerir as suas funções através dos seguintes métodos.

Disponibilidade da API

Estão disponíveis os seguintes métodos para as versões do cliente da API do Python 0.10.0 ou superior, utilizando versões de servidor 2025.2.0 ou superior.

Alguns dos métodos a seguir requerem um função_no_espaço_de_trabalho argumento. Este deve ser fornecido como um membro do Função no Espaço de Trabalho enum. Para utilizar a enum, importe-a a partir do common.py módulo:

python
de mergin.common import WorkspaceRole

Criar um utilizador ​

python
client.create_user(<email>, <password>, <workspace_id>, <workspace_role>, [username], [notify_user])

A pessoa que efetua a chamada deve ser um administrador do espaço de trabalho, o proprietário ou um administrador do servidor.

Argumentos:

e-mail (cadeia de caracteres): Deve ser um endereço de e-mail único.

palavra-passe (cadeia de caracteres): Deve cumprir os requisitos de segurança.

workspace_id (int) ℹ️ : O ID do espaço de trabalho ao qual o utilizador será adicionado.

função_no_espaço_de_trabalho (Função no Espaço de Trabalho (enum) ℹ️ : A função do utilizador no espaço de trabalho. Ver as opções de funções.

nome de utilizador (cadeia de caracteres, opcional): Se não for fornecida, será gerada automaticamente a partir do endereço de e-mail.

notify_user (Booleano, opcional): Se for verdadeiro, serão enviados e-mails de confirmação e outras comunicações por e-mail para o endereço de e-mail (convites, pedidos de acesso, etc.). O valor predefinido é Falso.

Exemplo:

python
de mergin.common import WorkspaceRole

client.create_user("jill@example.com", "T0p_secret", 1, Função na área de trabalho.EDITOR, notify_user=True)

ℹ️ workspace_id e função_no_espaço_de_trabalho Os argumentos são ignorados nos servidores da edição Community.

Métodos dos membros do espaço de trabalho ​

Estes métodos estão disponíveis para Mergin Maps Cloud e Mergin Maps EE.

Disponibilidade da API

Estão disponíveis os seguintes métodos para as versões do cliente da API do Python 0.10.0 ou superior, utilizando versões de servidor 2025.2.0 ou superior.

Quem chamar os métodos a seguir deve ser um administrador do espaço de trabalho, um proprietário ou um administrador do servidor.

Membros da lista ​

python
client.list_workspace_members(<workspace_id>)

Argumentos:

workspace_id (int): ID do espaço de trabalho.

Obter detalhes do membro ​

python
client.get_workspace_member(<workspace_id>, <user_id>)

Argumentos:

workspace_id (int): ID do espaço de trabalho.

user_id (int): ID do utilizador.

Atualizar função do membro ​

python
client.update_workspace_member(<workspace_id>, <user_id>, <workspace_role>, [reset_projects_roles])

Argumentos:

workspace_id (int): ID do espaço de trabalho.

user_id (int): ID do utilizador.

função_no_espaço_de_trabalho (Função no Espaço de Trabalho (enum): Nova função. Ver as opções de funções.

reiniciar_funções_dos_projetos (Booleano, opcional): Se for verdadeiro, as funções do projeto substituídas (acesso a projetos partilhados explicitamente) serão repostas. O valor predefinido é Falso.

Remover membro ​

python
client.remove_workspace_member(<workspace_id>, <user_id>)

Argumentos:

workspace_id (int): ID do espaço de trabalho.

user_id (int): ID do utilizador.

A conta do utilizador não é eliminada. Este método apenas retira o acesso do utilizador ao espaço de trabalho.

Convidar um utilizador para o espaço de trabalho ​

Disponibilidade da API

O método seguinte está disponível para as versões do Cliente da API do Python 0.10.3 ou superior, utilizando versões de servidor 2025.6.1 ou superior.

python
client.create_invitation(<workspace_id>, <email>, <workspace_role>)

Argumentos:

workspace_id (int): O ID do espaço de trabalho para o qual o utilizador será convidado.

e-mail (string): O endereço de e-mail de um utilizador existente.

função_no_espaço_de_trabalho (Função no Espaço de Trabalho (enum): A função do utilizador no espaço de trabalho. Ver as opções de funções.

Colaboradores do projeto e métodos ​

Estes métodos estão disponíveis para todos os tipos de servidor.

Disponibilidade da API

Estão disponíveis os seguintes métodos para as versões do cliente da API do Python 0.10.0 ou superior, utilizando versões de servidor 2025.2.0 ou superior.

Quem chamar os métodos a seguir deve ser um administrador do espaço de trabalho, proprietário, proprietário do projeto ou administrador do servidor.

Os métodos a seguir aceitam IDs de projeto (do tipo uuid). Pode encontrar o ID do projeto através de lista_de_projetos e informações_sobre_o_projeto métodos.

Alguns dos métodos a seguir requerem um função_no_projeto argumento. Este deve ser fornecido como um membro do Função no projeto enum. Para utilizar a enum, importe-a a partir do common.py módulo:

python
de mergin.common import ProjectRole

Listar os colaboradores do projeto ​

python
client.list_project_collaborators(<project_id>)

Argumentos:

project_id (string): ID do projeto.

Adicionar colaborador ao projeto ​

Adiciona um utilizador como colaborador do projeto. Este método é útil para partilhar projetos com convidados ou para atualizar as funções dos membros em projetos específicos. No Cloud, o utilizador tem de fazer parte do espaço de trabalho ao qual o projeto pertence.

python
client.add_project_collaborator(<project_id>, <user>, <project_role>)

Argumentos:

project_id (string): ID do projeto.

utilizador (string): E-mail ou nome de utilizador do utilizador a ser adicionado ao projeto.

função_no_projeto: (Função no projeto (enum): Função do utilizador no projeto. Ver as opções de funções

Atualizar a função de colaborador do projeto ​

python
client.update_project_collaborator(<project_id>, <user_id>, <project_role>)

Argumentos:

project_id (string): ID do projeto.

user_id (int): ID do utilizador.

função_no_projeto: (Função no projeto (enum): Nova função. Ver as opções de funções

O utilizador tem de ser primeiro adicionado ao projeto (através da opção «Adicionar colaborador ao projeto») antes de se recorrer a este método, mesmo que já seja membro do espaço de trabalho ou convidado.

Remover colaborador do projeto ​

python
client.remove_project_collaborator(<project_id>, <user_id>)

Argumentos:

project_id (string): ID do projeto.

user_id (int): ID do utilizador.

A conta de utilizador não é eliminada, apenas o acesso ao projeto.

Mais informações ​

O MerginMaps/python-api-client O repositório contém o código-fonte e mais informações sobre como utilizá-lo.

O repositório inclui também uma galeria de exemplos do Jupyter Notebooks com pequenos exemplos de código sobre como utilizar o módulo cliente Python para casos de utilização comuns, tais como a gestão de utilizadores, a sincronização ou a gestão de projetos.