Adicionando o conector
Baseado na documentação da API do Ploomes
Este conector está em modo beta
Requisitos
- Siga as instruções abaixo com um usuário administrador
Instruções
1) Acesse o site e faça login em sua conta Ploomes e, no painel lateral direito acesse Administração
2) Em integrações, selecione “Usuários de integração”
3) No modal, selecione “Novo usuário”
4) Preencha nome o “Kondado”, email “kondado@suaempresa.com.br” (utilize um email válido da sua empresa) e perfil Administrador > Criar usuário
5) Confirme a criação
6) Voltando ao modal de listagem de usuários, selecione o usuário Kondado recém criado
7) Copie a o valor exibido na caixa de“Chave da API”
8) Faça login na plataforma da Kondado, clique para criar um novo conector Ploomes e cole em “Chave da API” o valor obtido no passo 7
Agora basta clicar em SALVAR e criar suas integrações para começar a receber dados do Ploomes no seu Data Warehouse, Data Lake ou planilha
Integrações
Índice
- Cargos
- Cidades
- Cidades: estados
- Cidades: países
- Clientes (empresas e pessoas)
- Clientes: classificações
- Clientes: origens
- Clientes: relações
- Clientes: segmentos
- Clientes: status
- Clientes: tipos
- Departamentos
- Documentos
- Moedas
- Negócios
- Negócios: estágios
- Negócios: funis
- Negócios: motivos de perda
- Negócios: status
- Produtos
- Produtos: grupos
- Produtos: grupos: famílias
- Propostas
- Propostas: produtos
- Propostas: status de aprovação
- Registros de interação
- Tarefas
- Tarefas: intervalos de repetição
- Tarefas: tipos
- Tarefas: tipos de lembrete de email
- Usuários
- Usuários: motivos de suspensão
- Usuários: perfis
- Vendas
- Vendas: estágios
- Vendas: produtos
Gráfico de relacionamento
Clique para ampliar
Campos do Ploomes baseados em listas de seleções irão gerar 2 campos em sua tabela, terminados em “_val” e “_id”. Onde “_val” corressponderá ao texto da opção no momento da leitura dos dados e “_id” ao id desta opção. É possível que edições no texto da opção, diretamente na lista de opções, não alterem que não alterem o registro integrado diretamente, deixando este defasado
Campos do Ploomes que suportem múltiplas escolhas serão escritos em um mesmo campo da tabela da integração, separados por vírgulas
Entidades que suportem campos customizados irão trazer os todos os campos durante a criação da integração, não sendo criados novos campos após este momento, sendo necessária edição avançada para sincronização da lista de campos. Campos que deixem de existir no Ploomes apenas irão passar a ser escritos como nulos
Vendas: produtos
Campo | Tipo | |
---|---|---|
text |
[pt] Id da venda |
|
text |
[pt] Id do registro venda/produto |
|
text |
[pt] Id produto |
|
text |
[pt] Id do negócio da venda. |
|
text |
||
text |
||
float |
||
float |
||
float |
||
float |
||
float |
Vendas: estágios
Campo | Tipo | |
---|---|---|
text |
[pt] Id do estágio da venda, gerado automaticamente pelo Banco de Dados. |
|
text |
[pt] Nome do estágio da venda. |
|
text |
[pt] Ícone do estágio da venda. |
|
int |
[pt] Ordenação do estágio da venda. Esse é o número que define a ordem entre os estágios dentro de um funil, indo do menor para o maior. |
Vendas
Campo | Tipo | |
---|---|---|
text |
[pt] Id da venda, gerado automaticamente pelo Bando de Dados. |
|
int |
[pt] Número da venda. |
|
timestamp |
[pt] Data da venda, prenchida automaticamente com a data atual se nenhum valor for infomado. |
|
text |
[pt] Id do cliente da venda |
|
text |
[pt] Id da pessoa da venda |
|
text |
[pt] Id do estágio da venda. Assume um valor de um estágio padrão se não for informado |
|
text |
[pt] Id do negócio da venda. |
|
text |
[pt] Id do responsável da venda |
|
text |
[pt] Id da moeda da venda. Assume o valor da moeda do cliente ou da conta se não for informado |
|
float |
[pt] Valor da venda. |
|
text |
[pt] Disconto da venda. |
|
text |
[pt] Comentários internos da venda. |
|
text |
[pt] Descrição da venda. |
|
text |
[pt] Chave da venda. |
|
text |
[pt] Id do comissionado da venda. |
|
text |
[pt] Comissão da venda. |
|
text |
[pt] Id do modelo da venda |
|
boolean |
[pt] Indica se a venda foi compartilhada. |
|
boolean |
[pt] Indica se a venda foi aceita externamente. |
|
boolean |
[pt] Indica o recebimento de notificações externas. |
|
timestamp |
[pt] Data de compartilhamento da venda. |
|
text |
[pt] URL da venda (Quando compartilhada externamente). |
|
text |
[pt] Indica o status da aprovação da venda |
|
text |
[pt] Indica o nível de aprovação da venda. |
|
text |
[pt] Id da proposta origem da venda. |
|
text |
[pt] Nome do arquivo da venda. |
|
timestamp |
Usuários: perfis
Campo | Tipo | |
---|---|---|
text |
[pt] Id do perfil de usuário, gerado automaticamente pelo Banco de Dados. |
|
text |
[pt] Nome do perfil de usuário. |
Usuários: motivos de suspensão
Usuários
Campo | Tipo | |
---|---|---|
text |
[pt] Id do usuário, gerado automaticamente pelo Banco de Dados. |
|
text |
[pt] Nome do usuário. |
|
text |
[pt] Email do usuário. |
|
text |
[pt] Id do cargo do usuário |
|
text |
[pt] Id do perfil do usuário |
|
text |
[pt] Url do avatar do usuário (Foto). |
|
text |
[pt] Telefone do usuário. |
|
text |
[pt] Língua do usuário. |
|
text |
[pt] Facebook do usuário. |
|
text |
[pt] LinkedIn do usuário. |
|
text |
[pt] Id do motivo de suspensão do usuário. |
|
text |
[pt] Comentário sobre a suspensão do usuário. |
|
boolean |
[pt] Boleano que indica se é um usuário de integração (UserKey fixa). |
|
boolean |
[pt] Boleano que indica se é um usuário de integração nativa (Utilizado pelas integrações Plug-In-Play). |
|
boolean |
[pt] Boleano que indica se é um usuário cortesia (Não conta no pagamento). Usuários que não são de integração terão o valor de falso. |
|
timestamp |
Tarefas: tipos de lembrete de email
Tarefas: tipos
Campo | Tipo | |
---|---|---|
text |
[pt] Id do tipo de tarefa. |
|
text |
[pt] Nome do tipo de tarefa. |
|
text |
[pt] Ícone do tipo de tarefa. |
|
text |
[pt] Cor do tipo de tarefa. |
Tarefas: intervalos de repetição
Campo | Tipo | |
---|---|---|
text |
[pt] Id do intervalo de repetição. |
|
text |
[pt] Nome do intervalo de repetição. |
|
text |
[pt] Parte da data. |
|
int |
[pt] Tamanho da parte da data. |
Tarefas
Campo | Tipo | |
---|---|---|
text |
[pt] Id da tarefa, gerada automaticamente pelo Banco de Dados. |
|
text |
[pt] Título da tarefa. |
|
text |
[pt] Descrição da tarefa. |
|
text |
[pt] Id do tipo de tarefa |
|
text |
[pt] Id do contato da tarefa |
|
text |
[pt] Id do negócio da tarefa. |
|
int |
[pt] Duração da tarefa. |
|
int |
[pt] Duração do intervalo de repetição da tarefa. |
|
text |
[pt] Id do intervalo de repetição da Task |
|
text |
[pt] Id do lembrete por email |
|
timestamp |
Registros de interação
Campo | Tipo | |
---|---|---|
text |
[pt] Id do registro de interação, gerado automaticamente pelo Banco de Dados. |
|
text |
[pt] Id do cliente do registro de interação. Se for informado algum Id de negócio, o Id do cliente passa a ser o mesmo do cliente desse negócio. Caso contrário, o id do cliente deve ser válido para a criação do registro se completar |
|
text |
[pt] Id do negócio do registro de interação |
|
timestamp |
[pt] Data do registro de interação. Se estiver vazia, recebe a data atual da criação. |
|
text |
[pt] Id do tipo de registro de interação |
|
text |
[pt] Título do registro de interação. |
|
text |
[pt] Conteúdo do registro de interação. |
|
float |
[pt] Latitude do registro de interação (Se fizer sentido para o tipo dele). |
|
float |
[pt] Longitude do registro de interação (Se fizer sentido para o tipo dele). |
|
text |
[pt] Destinatários do email do registro de interação (Se fizer sentido para o tipo dele). |
|
text |
[pt] Assunto do email do registro de interação (Se fizer sentido para o tipo dele). |
|
timestamp |
Propostas: produtos
Campo | Tipo | |
---|---|---|
text |
[pt] Id da proposta |
|
text |
[pt] Id do registro proposta/produto |
|
text |
[pt] Id produto |
|
text |
[pt] Id do negócio da proposta. |
|
text |
||
text |
||
float |
||
float |
||
float |
||
float |
||
float |
Propostas: status de aprovação
Campo | Tipo | |
---|---|---|
text |
[pt] Id do status de aprovação da proposta. |
|
text |
[pt] Nome do status de aprovação da proposta. |
Propostas
Campo | Tipo | |
---|---|---|
text |
[pt] Id da proposta, gerado automaticamente pelo Banco de Dados. |
|
text |
[pt] Id do negócio da proposta. |
|
text |
[pt] Id do modelo da proposta |
|
text |
[pt] Id do status de aprovação da proposta |
|
int |
[pt] Número da proposta. |
|
boolean |
[pt] Indica se a proposta foi compartilhado. |
|
boolean |
[pt] Indica o recebimento de notificações externas. |
|
timestamp |
[pt] Data de compartilhamento da proposta. |
|
text |
[pt] Id da última revisão. |
|
timestamp |
Produtos: grupos: famílias
Campo | Tipo | |
---|---|---|
text |
[pt] Id da família de produto, gerado automaticamente pelo Banco de Dados. |
|
text |
[pt] Nome da família de produto. |
Produtos: grupos
Campo | Tipo | |
---|---|---|
text |
[pt] Id do grupo de produto, gerado automaticamente pelo Banco de Dados. |
|
text |
[pt] Nome do grupo de produto. |
|
text |
[pt] Id da família do grupo de produto |
|
boolean |
[pt] Indica se o preço é fixado nesse grupo de produto. |
|
boolean |
[pt] Indica se esse grupo de produto é padrão. |
Produtos
Campo | Tipo | |
---|---|---|
text |
[pt] Id do produto, gerado automaticamente pelo Banco de Dados. |
|
text |
[pt] Id do grupo do produto. |
|
text |
[pt] Nome do produto. |
|
text |
[pt] Código do produto. |
|
text |
[pt] Unidade de medida do produto. |
|
text |
[pt] Imagem do produto. |
|
text |
[pt] Id da moeda do produto. Essa informação pode ser consultada no endpoint de '/Currencies'. |
|
float |
[pt] Unit value of the product. |
|
timestamp |
Negócios: status
Negócios: motivos de perda
Campo | Tipo | |
---|---|---|
text |
[pt] Id do motivo de perda, gerado automaticamente pelo Banco de dados. |
|
text |
[pt] Nome do motivo de perda. |
|
text |
[pt] Id do funil do motivo de perda. |
Negócios: funis
Campo | Tipo | |
---|---|---|
text |
[pt] Id do Funil de negócio, gerado automaticamente pelo Banco de Dados. |
|
text |
[pt] Nome do funil de negócio. |
|
boolean |
[pt] Boleano que indica se a passagem por todos os estágios é obrigatória neste funil. Assume o valor de falso se não for informado. |
|
boolean |
[pt] Boleano que indica se é proibido voltar de etapa neste funil. Assume o valor de falso se não for informado. |
|
boolean |
[pt] Boleano que indica se pode gerar propostas neste funil. Assume o valor de falso se não for informado. |
|
boolean |
[pt] Boleano que indica se pode gerar vendas neste funil. Assume o valor de falso se não for informado. |
|
boolean |
[pt] Boleano que indica se pode gerar documentos neste funil. Assume o valor de falso se não for informado. |
|
boolean |
[pt] Boleano que indica se pode ganhar negócios neste funil. Assume o valor de falso se não for informado. |
|
boolean |
[pt] Boleano que indica se pode perder propostas neste funil. Assume o valor de falso se não for informado. |
|
text |
[pt] Id do formulário do funil de negócio. |
|
text |
[pt] Id do formulário mini do funil de negócio. |
|
boolean |
[pt] Indica de o formulário está arquivado. Assume o valor de falso inicialmente. |
|
boolean |
[pt] Boleano que indica se deve gerar uma nova venda ao ganhar um negócio neste funil (Abrindo a janela de criação de uma nova venda). Assume o valor de falso se não for informado. |
|
boolean |
[pt] Boleano que indica se deve gerar uma nova venda automaticamente ao ganhar um negócio neste funil. Assume o valor de falso se não for informado. |
|
boolean |
[pt] Boleano que indica se é possível ganhar um negócio apenas na última etapa neste funil. Assume o valor de falso se não for informado. |
|
text |
[pt] Nome da unidade no singular desse funil. |
|
text |
[pt] Nome da unidade no plural desse funil. |
|
text |
[pt] Gênero da unidade desse funil. |
|
boolean |
[pt] Boleano que indica se a visualização de tabela está disponível. |
|
boolean |
[pt] Boleano que indica se a visualização de Funil/Kanban está disponível. |
|
int |
[pt] Ordenação do funil. |
|
boolean |
[pt] Boleano que indica se deve usar formato de tela cheia para criação/edição de propostas neste funil. |
|
boolean |
[pt] Boleano que indica se deve usar formato de tela cheia para criação/edição de vendas neste funil. |
|
boolean |
[pt] Boleano que indica se deve usar formato de tela cheia para criação/edição de documentos neste funil. |
Negócios: estágios
Campo | Tipo | |
---|---|---|
text |
[pt] Id da estágio do negócio, gerado automaticamente pelo Banco de Dados. |
|
text |
[pt] Nome do estágio do negócio. |
|
text |
[pt] Funil do estágio do negócio. Essa informação pode ser consultada no endpoint '/Deals@Pipelines'. |
|
int |
[pt] Ordenação do estágio do negócio. Esse é o número que define a ordem entre os estágios dentro de um funil, indo do menor para o maior. Não é possível inserir estágios com ordenação igual dentro do mesmo funil. |
Negócios
Campo | Tipo | |
---|---|---|
text |
[pt] Id do negócio, gerado automaticamente pelo Banco de Dados. |
|
text |
[pt] Título do negócio. |
|
text |
[pt] Id do cliente do negócio. Se o negócio não possuir nenhum cliente, o cliente Fantasma da conta será adicionado (É um id de cliente que todas as contas possuem para representar um cliente vazio) |
|
text |
[pt] Id da pessoa do negócio |
|
text |
[pt] Id do status do negócio |
|
text |
[pt] Id do funil do negócio |
|
text |
[pt] Id do estágio do negócio. Se o estágio não for informado, esse campo será preenchido com o primeiro estágio de um funil não arquivado. |
|
text |
[pt] Id do último estágio do negócio. |
|
text |
[pt] Id do motivo de perda do negócio. |
|
text |
[pt] Id da origem do negócio. |
|
text |
[pt] Id do responsável do negócio. |
|
text |
[pt] Id da moeda do negócio. Será inserido nesse campo a moeda do cliente ou a moeda padrão da conta. |
|
float |
[pt] Valor do negócio. Esse campo tem um valor padrão de 0. |
|
text |
[pt] Id do negócio origem desse negócio. Esse campo estará preenchido se esse negócio for um negócio derivado de outro. |
|
int |
[pt] Número do negócio. |
|
text |
[pt] Id do produto de cliente do negócio. |
|
timestamp |
Moedas
Campo | Tipo | |
---|---|---|
text |
[pt] Id da moeda, gerado automaticamente pelo Banco de dados. |
|
text |
[pt] Símbolo da moeda. |
|
text |
[pt] Código da moeda. |
Documentos
Campo | Tipo | |
---|---|---|
text |
[pt] Id do documento, gerado automaticamente pelo Bando de Dados. |
|
text |
[pt] Nome do documento. |
|
int |
[pt] Número do documento. |
|
timestamp |
[pt] Data do documento, prenchida automaticamente com a data atual se nenhum valor for infomado. |
|
text |
[pt] Id do modelo do documento |
|
text |
[pt] Id do cliente do documento |
|
text |
[pt] Id da pessoa do documento |
|
text |
[pt] Id do negócio do documento |
|
text |
[pt] Id do responsável do documento |
|
text |
[pt] Chave do documento. |
|
boolean |
[pt] Indica se o documento foi compartilhado. |
|
boolean |
[pt] Indica se o documento foi aceito externamente. |
|
boolean |
[pt] Indica o recebimento de notificações externas. |
|
timestamp |
[pt] Data de compartilhamento do documento. |
|
text |
[pt] URL do documento (Quando compartilhado externamente). |
|
text |
[pt] Id do status da aprovação do documento. |
|
text |
[pt] Indica o nível de aprovação do documento. |
|
text |
[pt] Id da proposta origem do documento. |
|
text |
[pt] Id da moeda do documento |
|
text |
[pt] Nome do arquivo do documento. |
|
timestamp |
Departamentos
Campo | Tipo | |
---|---|---|
text |
[pt] Id do departamento, gerado automaticamente pelo Banco de Dados. |
|
text |
[pt] Nome do departamento. |
Clientes: tipos
Clientes: status
Campo | Tipo | |
---|---|---|
text |
[pt] Id do status do cliente, gerado automaticamente pelo Banco de Dados. |
|
text |
[pt] Nome do status do cliente. |
Clientes: relações
Campo | Tipo | |
---|---|---|
text |
[pt] Id da relação, gerado automaticamente pelo Banco de Dados. |
|
text |
[pt] Nome da relação. |
Clientes: segmentos
Campo | Tipo | |
---|---|---|
text |
[pt] Id do Segmento , gerado automaticamente pelo Banco de Dados. |
|
text |
[pt] Nome do Segmento. |
Clientes: origens
Campo | Tipo | |
---|---|---|
text |
[pt] Id da origem, gerado automaticamente pelo banco de dados. |
|
text |
[pt] Nome da origem. |
Clientes: classificações
Campo | Tipo | |
---|---|---|
text |
[pt] Id da relação, gerado automaticamente pelo Banco de Dados. |
|
text |
[pt] Nome da relação. |
Clientes (empresas e pessoas)
Campo | Tipo | |
---|---|---|
text |
[pt] Id do cliente, gerado automaticamente pelo Banco de dados. |
|
text |
[pt] Id do tipo do cliente, podendo ser um cliente do tipo pessoa ou do tipo empresa. |
|
text |
[pt] Id da classe do cliente. |
|
text |
[pt] Nome do cliente. |
|
text |
[pt] Razão social do cliente. |
|
text |
[pt] CNPJ ou CPF do cliente, a escolha do tipo do campo é de acordo com o tipo do cliente. |
|
text |
[pt] Id do status do cliente. Se não estiver preenchido, assume um valor padrão |
|
text |
[pt] Id da empresa do cliente (Se aplica para clientes do tipo pessoa). |
|
text |
[pt] Id da relação do cliente |
|
text |
[pt] Id do segmento do cliente |
|
text |
[pt] Id da origem do cliente |
|
text |
[pt] Id do usuário responsável do cliente. |
|
text |
[pt] Observações sobre o cliente. |
|
text |
[pt] Email do cliente. |
|
text |
[pt] Site do cliente. |
|
text |
[pt] Id do cargo do cliente |
|
text |
[pt] Id do departamento do cliente |
|
text |
[pt] Skype do cliente. |
|
text |
[pt] Facebook do cliente. |
|
text |
[pt] Endereço do cliente. |
|
text |
[pt] Número do endereço do cliente. |
|
text |
[pt] Complemento do endereço do cliente. |
|
text |
[pt] Bairro do cliente. |
|
int |
[pt] CEP do cliente. |
|
text |
[pt] Código postal internacional do cliente. |
|
text |
[pt] Id da cidade do cliente |
|
text |
[pt] Id da moeda do cliente |
|
boolean |
[pt] Boleano sobre o recebimento de email marketing. |
|
text |
[pt] Código CNAE do cliente. |
|
text |
[pt] Descrição do CNAE do cliente. |
|
float |
[pt] Latitude do cliente. |
|
float |
[pt] Longitude do cliente. |
|
text |
[pt] Chave externa do cliente. |
|
text |
[pt] URL do avatar do cliente (Ícone). |
|
text |
[pt] Documento de identidade internacional do cliente. |
|
timestamp |
Cidades: países
Campo | Tipo | |
---|---|---|
text |
[pt] Id do país, gerado automaticamente pelo Banco de dados. |
|
text |
[pt] Código Alpha-3. Representa a sigla do país, com 3 letras. |
|
text |
[pt] Código Alpha-2. Representa a sigla do país, com 2 letras. |
|
text |
[pt] Nome do País. |
Cidades: estados
Campo | Tipo | |
---|---|---|
text |
[pt] Id do estado, gerado automaticamente pelo Banco de dados. |
|
text |
[pt] Sigla do estado. |
|
text |
[pt] Nome do estado. |
|
text |
[pt] Id do país desse estado |
Cidades
Campo | Tipo | |
---|---|---|
text |
[pt] Id da cidade, gerado automaticamente pelo Banco de dados. |
|
text |
[pt] Nome da cidade. |
|
text |
[pt] Id do país da cidade |
|
text |
[pt] Id do estado da cidade |
|
int |
[pt] Código do IBGE da cidade. |
|
text |
[pt] Latitude da cidade. |
|
text |
[pt] Longitude da cidade. |