Ao criar um conector ou destino na Kondado, você pode optar por convidar um usuário temporário para fazer esta criação de maneira segura. Este usuário não terá acesso à sua conta e poderá apenas criar este conector ou destino. Veja aqui como fazer isso pela interface gráfica
Ao utilizar nossa API para este processo, você tem a possibilidade de desenvolver um fluxo transparente, onde seu usuário não precisará compartilhar senhas com seu time e você poderá após a criação de um conector/destino criar novas integrações
Criar um novo convite
Esta rota está disponível apenas para clientes com planos Enterprise (iniciam em 100 milhões de registros)
Descrição
Cria um convite e devolve um link de acesso
Método
POST
Endpoint
/collection_guests
Parâmetros da URL
client_id
- Descrição: Parâmetro que indica o id da conta onde será criado o conector ou destino. Pode ser obtido em app.kondado.com.br/account (estará ao lado do nome de seu time, no formato XXXXX-Y, onde XXXXX é o seu client id)
- Obrigatório: sim
- Formato: número inteiro
recipient_email
- Descrição: Parâmetro que indica o email do usuário que receberá o convite. Você pode utilizar um email padrão caso não deseje que o usuário em questão receba um convite por email (o link será exposto no retorno)
- Obrigatório: sim
- Formato: texto
parent_collection_id
- Descrição: Parâmetro que indica o id da parent collection (conector/destino) a ser utilizada - veja aqui como listar e obter as parent collections
- Obrigatório: sim
- Formato: número inteiro
parent_collection_direction
- Descrição: Parâmetro que indica se a parent collection refere-se a:
src: um conectordest: um destino
- Obrigatório: sim
- Formato: valores fixos
srcoudest
assigned_collection_name
- Descrição: Parâmetro que indica o nome que receberá o conector ou destino
- Obrigatório: sim
- Formato: texto
Exemplo de chamada (body)
{
"client_id": "123456789",
"recipient_email": "julia-pizzol@kondado.ai",
"parent_collection_id": 130,
"parent_collection_direction": "src",
"assigned_collection_name": "[Guest] Toggl"
}
Exemplo de resposta (body)
{
"success": true,
"data": {
"success": true,
"data": {
"link": "https://app.kondado.com.br/collection_guest/eyJnasukaskxaskxbaskdbaskbdaksjcnkjqwkudhauwkdnasjklxn"
}
}
}
Descrição do retorno
O objeto data irá retornar um parâmetro link com a URL que poderá ser acessada para criar o conector ou destino conforme requisição
Criar convites para adicionar conectores e destinos na Kondado
Aprenda a usar convites temporários para permitir que usuários externos criem conectores ou destinos de forma segura, sem acesso à sua conta.
Verifique seu plano Enterprise
Certifique-se de que sua conta possui um plano Enterprise (a partir de 100 milhões de registros), pois a rota de convites está disponível apenas para esses clientes. Caso precise atualizar, consulte a página de preços.
Obtenha o client_id da conta
Acesse app.kondado.com.br/account para localizar seu client_id, que estará ao lado do nome do seu time no formato XXXXX-Y. Este parâmetro é obrigatório para criar o convite via API.
Defina a parent collection e direção
Identifique o id da parent collection (conector ou destino) que será utilizada e especifique a direção: src para conectores ou dest para destinos.
Monte a requisição POST
Utilize o endpoint /collection_guests com os parâmetros obrigatórios: client_id, recipient_email, parent_collection_id, parent_collection_direction e assigned_collection_name. O email pode ser genérico se não desejar enviar notificação.
Compartilhe o link de acesso
Após a chamada API, capture o link retornado no objeto data e encaminhe ao usuário convidado. Ele poderá criar o conector ou destino sem ter acesso permanente à sua conta.
Perguntas frequentes
recipient_email é obrigatório, mas você pode utilizar um email padrão ou fictício caso não deseje que o usuário receba um convite por email. Nesse caso, o link de acesso será exposto diretamente no retorno da API para que você o compartilhe manualmente.client_id pode ser obtido em app.kondado.com.br/account, ao lado do nome do seu time, no formato XXXXX-Y, onde XXXXX é o seu client_id. Este é um número inteiro obrigatório para todas as chamadas de criação de convites.