Na Kondado, Parent Pipelines são os tipos de integrações que você pode criar a partir de cada tipo de conector. Não deve ser confundido com as integrações (Pipelines), já que os Parent Pipelines são a etapa anterior à criação de uma integração - toda integração (Pipeline) tem um tipo de integração (Parent Pipeline).
Listar tipos de integrações disponíveis para criação
Descrição
Lista os tipos de integrações de um dado tipo de conector (Parent Collection) que estão disponíveis para criação para o usuário do token. Este endpoint necessita que seja informado o ID do tipo de conector (parent_collection_id), que pode ser obtido pelo endpoint de Parent Collections
Método
GET
Endpoint
/parent_collections/src/:parent_collection_id/parent_pipelines
Parâmetros da URL
Nenhum
Exemplo de resposta
{
"success": true,
"data": [
{
"id": 92,
"parent_collection_name": "Tangerino",
"parent_pipelines": [
{
"id": 290,
"createdAt": "2021-02-24T20:46:14.950Z",
"updatedAt": "2021-02-24T20:46:14.950Z",
"parent_pipeline_name": "Funcionários",
"is_billable": true
},
{
"id": 289,
"createdAt": "2021-02-24T14:40:36.552Z",
"updatedAt": "2021-02-24T14:40:36.552Z",
"parent_pipeline_name": "Resumo diário",
"is_billable": true
},
{
"id": 284,
"createdAt": "2021-02-09T19:32:45.828Z",
"updatedAt": "2021-02-09T19:32:45.828Z",
"parent_pipeline_name": "Registros de ponto",
"is_billable": true
}
]
}
]
}
Descrição do retorno
O retorno irá conter dados da parent_collection (id e parent_collection_name) e um array de JSONs com os parent pipelines encontrados com os seguintes campos:
id
ID do parent_pipeline
createdAt
Data de criação do registro
updatedAt
Data de última atualização do registro
parent_pipeline_name
Nome do tipo de integração
is_billable
Se esta integração é gratuita ou não
Consultar Parent Pipelines via API da Kondado
Aprenda a listar os tipos de integrações disponíveis para cada conector usando o endpoint de Parent Pipelines da API Kondado.
Obtenha o ID do conector (Parent Collection)
Antes de consultar os Parent Pipelines, você precisa do parent_collection_id do conector desejado. Esse ID é obtido pelo endpoint de Parent Collections.
Faça a requisição GET no endpoint correto
Utilize o método GET no endpoint /parent_collections/src/:parent_collection_id/parent_pipelines, substituindo o parâmetro pelo ID do conector obtido no passo anterior.
Analise a resposta com os tipos de integração
O retorno traz o parent_collection_name (ex: "Tangerino") e um array de parent_pipelines com campos como id, parent_pipeline_name (ex: "Funcionários", "Registros de ponto") e is_billable que indica se é paga ou gratuita.
Utilize o Parent Pipeline escolhido para criar uma integração
Com o id do Parent Pipeline desejado, prossiga para criar sua integração de dados (Pipeline) na Kondado.
Perguntas frequentes
parent_collection_id deve ser obtido pelo endpoint de Parent Collections, que lista os tipos de conectores disponíveis. Consulte a documentação de conectores para mais detalhes sobre os conectores suportados.is_billable indica se aquela integração específica é paga (true) ou gratuita (false). No exemplo da documentação, as integrações "Funcionários", "Resumo diário" e "Registros de ponto" do Tangerino são marcadas como pagas.id (identificador), createdAt (data de criação), updatedAt (última atualização), parent_pipeline_name (nome do tipo de integração) e is_billable (se é paga ou não).