Convites para adicionar conectores e destinos

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

parent_collection_direction

  • Descrição: Parâmetro que indica se a parent collection refere-se a:
    • src: um conector
    • dest: um destino
  • Obrigatório: sim
  • Formato: valores fixos src ou dest

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