Ajuda Skynova

Menu

SkyAPI Requests - Script para executar ações em lote via API

Avatar
Alessandro Rosão
  • Atualizado
Esse script reúne diversas funções administrativas que não estão disponíveis diretamente no Painel de Controle por motivos de segurança. No entanto, caso você seja administrador do domínio, ele pode ser utilizado para executar ações em lote de forma rápida e eficiente no seu próprio ambiente.
 
Entre as funcionalidades disponíveis, o script permite realizar operações administrativas em massa, como remover contas de e-mail em lote, recuperar contas deletadas, desabilitar contas em lote, gerenciar ou alterar senhas em lote, renomear contas em lote e atualizar atributos das caixas postais em lote.
 
Essas opções são úteis principalmente em cenários que envolvem grande volume de contas, onde a execução individual pelo Painel de Controle não seria prática.
 
Realize download dos arquivos deste guia: Clicando Aqui!
 

1. Gerando Token JWT

Para gerar o Token JWT utilizado para realizar chamadas de API você precisa de 2 informações: usuário e senha do painel de controle e a chave privada do painel.
 
Acesse o painel de controle da Skymail. Em seguida, clique em Minha Conta e selecione Configurações da Conta, localizado no canto superior direito da tela.

Em seguida, clique em Interface API e copie a chave privada da sua organização. Certifique-se de armazená-la em um local seguro.

O token de autorização deve ser gerado apenas uma vez. Ele está atrelado ao usuário do painel de controle utilizado para criá-lo e funcionará enquanto o usuário estiver ativo.
 
Execute o script api-requests.ps1 como administrador no PowerShell. Na primeira tela serão exibidas duas opções:
 
Opção 1 - Gerar um novo token: escolha esta opção caso ainda não possua um token. Preencha o usuário, a senha do painel e a chave privada quando solicitado.
 
Opção 2 - Já tenho um token: escolha esta opção caso já possua um token gerado anteriormente. Basta colar o token quando solicitado.

Observação: Este é o token principal de autorização que utilizaremos para as chamadas da API. Copie-o e armazene-o em um local seguro.

2. Executando as chamadas de API

Para realizar as ações em lote, basta executar o Script api-requests.ps1, ele solicitará qual ação deseja tomar, basta selecionar a opção desejada e preencher o que for requisitado:

Em cada chamada, o arquivo CSV informado deve seguir um formato específico. Abaixo está a lista com a estrutura esperada para cada tipo de CSV:

Opção 1 — Deletar Contas

Exclui as contas listadas.
conta1@dominio.com.br
conta2@dominio.com.br
etc...

 

Opção 2 — Recuperar Contas Deletadas

Restaura contas que foram deletadas até 30 dias.

conta1@dominio.com.br
conta2@dominio.com.br
etc...

 

Opção 3 — Atualizar Status da Conta

Desabilita, bloqueia o acesso ou reativa as contas listadas. O status é escolhido no menu antes de informar o CSV.
 
conta1@dominio.com.br
conta2@dominio.com.br
etc...

 

Opção 4 — Gerenciador de Senhas

#### 4.1 — Trocar senha (mesma senha para todas as contas)

conta1@dominio.com.br
conta2@dominio.com.br
etc...

#### 4.2 — Trocar senha (senha diferente para cada conta) O separador é o ponto e vírgula (;).
conta1@dominio.com.br;Senha@123
conta2@dominio.com.br;Senha@321
etc...

### 4.3 — Forçar troca de senha no próximo login. Não altera a senha atual, apenas obriga o usuário a redefini-la no próximo acesso.
conta1@dominio.com.br
conta2@dominio.com.br
etc...

 

Opção 5 — Renomear Contas

O separador é a vírgula (,). Informe o e-mail atual e o novo e-mail.
 
conta1@dominio.com.br,conta1.novo@dominio.com.br
conta2@dominio.com.br,conta2.novo@dominio.com.br
etc...

 

Opção 6 — Atualizar Atributos da Caixa Postal

Esta é a única opção que exige cabeçalho no CSV. Inclua apenas as colunas que deseja atualizar a coluna mailbox é obrigatória, as demais são opcionais.

Formato dos campos de telefone

Os campos Celular, Telefone residencial e Telefone comercial precisam ter no mínimo 10 dígitos numéricos (DDD + número). O script formata o valor automaticamente antes de enviar à API:

Atenção: Números com menos de 10 dígitos são ignorados e o campo não é atualizado. Os demais campos da mesma conta continuam sendo processados normalmente. Ao final da execução, o script exibe um relatório listando cada campo de telefone ignorado, a conta e o valor informado.

 
mailbox,Nome,Email secundario,Celular,Telefone residencial,Telefone comercial,Empresa,Unidade,Departamento,Cargo
conta1@dominio.com.br,Nome Sobrenome,secundario@gmail.com,11999990001,1133330001,1133330002,Nome da Empresa,Unidade SP,TI,Analista
conta2@dominio.com.br,Nome Sobrenome,secundario2@gmail.com,11999990002,1133330003,1133330004,Nome da Empresa,Unidade RJ,RH,Gerente

É possível subir um CSV apenas com as colunas que deseja alterar. Por exemplo, para atualizar apenas o nome e cargo

mailbox,Nome,Cargo
conta1@dominio.com.br,Rafael Silva,Gerente

 

Opção 7 — Deletar Grupos de E-mail

Remove permanentemente os grupos de e-mail listados. Esta ação não pode ser desfeita.
 
grupo1@dominio.com.br
grupo2@dominio.com.br
etc...

 

Opção 8 — Deletar Zonas DNS

Remove permanentemente as zonas DNS dos domínios listados. Esta ação não pode ser desfeita.
 
dominio1.com.br
dominio2.com.br
etc...

 

Qualquer BUG ou Problema reporte para nossos analistas via suporte@skymail.com.br!

Artigos relacionados