Bitrix24

objetivo o conector bitrix24 integra a plataforma fluid com a api rest do bitrix24, permitindo a leitura de negócios, clientes (contatos e empresas), requisitos, endereços e produtos diretamente do crm com ele é possível enriquecer fluxos com dados do crm, sincronizar cadastros com sistemas externos e orquestrar consultas encadeadas (por exemplo, descobrir os endereços de um cliente a partir de seus requisitos, ou obter o preço base de um produto a partir do tipo de preço) a comunicação é feita por webhook de entrada ( inbound webhook ) do bitrix24, autenticando cada chamada com a url gerada no próprio portal — sem necessidade de fluxo oauth documentação oficial da api este conector utiliza a api rest do bitrix24 (métodos universais de crm crm item , além de crm requisite list , crm address list e dos métodos de catálogo catalog product get , catalog pricetype list e catalog price list ) para detalhes de cada método, parâmetros e formato de resposta, acesse o portal de desenvolvedores https //apidocs bitrix24 com https //apidocs bitrix24 com o bitrix24 está disponível em versão nuvem (empresa bitrix24 com) e on premise o conector funciona em ambas, desde que a url do webhook de entrada esteja acessível pela fluid requisitos (conexão) método de autenticação o bitrix24 autentica via webhook de entrada ao gerar o webhook no portal (em recursos para desenvolvedores → outros → webhook de entrada ), o bitrix24 fornece uma url no formato https //empresa bitrix24 com/rest/{id do usuario}/{token do webhook}/ o conector monta automaticamente essa base e anexa o método de cada operação a partir dos três campos da conexão o token do webhook é uma credencial sensível e, por padrão, não expira trate o como uma senha, conceda ao webhook apenas as permissões necessárias (ex somente crm) e faça rotação periódica campos obrigatórios (schema da conexão) campo chave descrição exemplo endereço do portal host host completo do bitrix24, sem https // e sem barra final empresa bitrix24 com id do usuário userid identificador do usuário dono do webhook 1 token do webhook webhooktoken código do webhook de entrada gerado no bitrix24 (campo sensível) xxxxxxxxxxxxxxxx internamente, a conexão resulta na url base https //{host}/rest/{userid}/{webhooktoken} configuração de fluxo cada passo do conector exige a escolha de um recurso e de uma operação a requisição é enviada por post para o método correspondente, com content type application/json o caminho da chamada é sempre o nome do método seguido de json (ex crm item get json ) corpo da requisição a forma de montar o corpo (body) depende da operação campos dinâmicos — você preenche cada campo individualmente na interface e o conector cuida da tipagem automaticamente é a estratégia da maioria das operações (buscar negócio/cliente/produto, listar entregas e pagamentos do negócio, listar produtos do negócio, listar tipos de preço e listar preços) template — você escreve o corpo em go template (sprig), com liberdade total para referenciar dados de passos anteriores via steps \<nome do passo> body e montar estruturas dinâmicas indicado para corpos complexos e filtros avançados esta opção fica disponível, como alternativa aos campos dinâmicos, nas operações listar requisitos do cliente e listar endereços do cliente recursos e operações a seguir, o resumo das operações disponíveis no conector os nomes em negrito são os mesmos campos que aparecem na interface do passo negócios operação o que informar buscar negócio tipo da entidade (negócio = 2), id do negócio listar entregas do negócio tipo da entidade (negócio = 2), id do negócio listar pagamentos do negócio tipo da entidade (negócio = 2), id do negócio clientes operação o que informar buscar cliente tipo da entidade (contato = 3, empresa = 4), id do cliente listar requisitos do cliente tipo da entidade (contato = 3, empresa = 4), id do cliente campo campos a retornar opcional (ex id, rq cpf, rq cnpj) listar endereços do cliente tipo da entidade (endereço de requisito = 8), id do requisito (o rq retornado por listar requisitos do cliente ) os endereços de cliente no bitrix24 são vinculados ao requisito (rq), não diretamente ao contato/empresa por isso, para chegar aos endereços é necessário primeiro listar os requisitos do cliente e usar o id retornado como id do requisito na listagem de endereços (com tipo da entidade = 8) produtos operação o que informar listar produtos do negócio tipo do dono (negócio = d), id do dono (id do negócio) campo paginação (start) opcional buscar produto do catálogo id do produto (no catálogo) listar tipos de preço nenhum obrigatório filtros opcionais ( tipo de preço base , id do tipo de preço , nome do tipo de preço , xml id ) e campos a retornar opcional sem filtro, retorna todos os tipos de preço listar preços do produto nenhum obrigatório, mas normalmente filtra se por id do produto e/ou tipo de preço campo campos a retornar opcional na operação listar produtos do negócio , o campo paginação (start) controla a paginação cada página retorna sempre 50 registros para a 1ª página informe 0 , para a 2ª informe 50 , para a 3ª informe 100 , e assim por diante ( start = (n 1) × 50 ) em listar preços do produto , o campo tipo de preço corresponde ao grupo de catálogo do bitrix24 para descobri lo dinamicamente, use antes a operação listar tipos de preço e reaproveite o id retornado na prática nesta seção vamos montar um fluxo de exemplo buscar um negócio exemplo buscar um negócio fluxo com um único passo, cujo objetivo é retornar os dados de um negócio pelo seu id adicione um passo do conector bitrix24 ao canvas em recurso , selecione negócios em operação , selecione buscar negócio em corpo da requisição , preencha os campos tipo da entidade = 2 id do negócio = 1 (o negócio que deseja consultar) ao executar, o passo retorna os dados do negócio informado boas práticas confirme o tipo da entidade antes de publicar negócio = 2, contato = 3, empresa = 4, endereço de requisito = 8 um tipo incorreto retorna registro vazio sem gerar erro explícito use ids retornados para operações futuras , como nos encadeamentos requisito → endereço e tipo de preço → preço descubra o tipo de preço dinamicamente com a operação listar tipos de preço (filtrando tipo de preço base = y para o preço base), em vez de fixar o tipo de preço no fluxo pagine resultados longos em listar produtos do negócio com o campo paginação (start) (50 registros por página) restrinja as permissões do webhook apenas aos escopos necessários (ex crm, catálogo) disparo do fluxo o fluxo pode ser acionado conforme os mecanismos padrão da fluid por eventos/webhooks , agendamentos (scheduler) , chamada via url de disparo ou execução manual para teste recomendações de teste comece com uma operação de leitura simples ( buscar negócio ) e um id conhecido, validando headers e o body da resposta conclusão o conector bitrix24 conecta a fluid à api rest do bitrix24, cobrindo consultas a negócios, clientes, requisitos, endereços e produtos a autenticação simplificada por webhook de entrada e a flexibilidade entre campos dinâmicos e template permitem desde consultas diretas até fluxos encadeados mais elaborados para aprofundar nos métodos e parâmetros, consulte sempre a documentação oficial do bitrix24 https //apidocs bitrix24 com/