Skip to main content

Bridge Python SDK da Vezor

Project description

Vezor SDK Python

Python Version License: MIT PyPI version

SDK oficial da Vezor para integração com APIs de comunicação e CRM. Este pacote Python fornece interfaces simples e intuitivas para trabalhar com a EvoAPI e Kommo CRM.

Instalação

pip install vezor-sdk

Requisitos

  • Python 3.8 ou superior
  • requests >= 2.31.0

Módulos Disponíveis

VzrClient - Cliente Base

Cliente genérico para APIs da Vezor com funcionalidades básicas de autenticação e requisições.

EvoApiClient - Integração EvoAPI

Cliente especializado para integração com a EvoAPI, oferecendo métodos para gerenciar contatos, clientes e mensagens.

KommoApiClient - Integração Kommo CRM

Cliente para integração com o Kommo CRM v4, permitindo gerenciar pipelines, status, tags e webhooks.

Uso

VzrClient - Cliente Base

from vezor_sdk import VzrClient

# Inicializar cliente
client = VzrClient(
    base_url="https://api.vezor.cloud",
    api_key="sua_api_key_aqui"
)

# Teste de conexão
response = client.ping()
print(response)

# Buscar dados de um recurso
data = client.get_data("usuarios")
print(data)

EvoApiClient - Integração EvoAPI

from vezor_sdk import EvoApiClient

# Inicializar cliente EvoAPI
evo_client = EvoApiClient(
    base_url="https://evoapi.vezor.cloud",
    instance="sua_instancia",
    api_key="sua_api_key"
)

# Obter contatos
contatos = evo_client.get_contacts()
print(f"Total de contatos: {len(contatos)}")

# Obter contatos e salvar em arquivo
contatos = evo_client.get_contacts(save_path="contatos.json")

# Obter clientes com filtros
filtros = {"status": "ativo"}
clientes = evo_client.get_clients(filters=filtros)

# Obter todas as mensagens
mensagens = evo_client.get_messages(save_path="mensagens.json")
print(f"Total de mensagens: {len(mensagens)}")

KommoApiClient - Integração Kommo CRM

from vezor_sdk import KommoApiClient

# Inicializar cliente Kommo
kommo_client = KommoApiClient(
    base_url="https://minhaempresa.kommo.com",
    token="seu_token_oauth2"
)

# Obter pipelines
pipelines = kommo_client.get_pipelines()
for pipeline in pipelines:
    print(f"Pipeline: {pipeline['name']} (ID: {pipeline['id']})")

# Obter status de um pipeline
statuses = kommo_client.get_pipeline_statuses(pipeline_id=12345)

# Gerenciar tags
tags = kommo_client.get_lead_tags()
nova_tag = kommo_client.create_lead_tag("Nova Tag", "FF0000")

# Gerenciar webhooks
webhooks = kommo_client.get_webhooks()
novo_webhook = kommo_client.create_webhook(
    destination="https://meusite.com/webhook",
    settings=["lead_add", "lead_update"]
)

Autenticação

VzrClient

  • API Key: Token Bearer para autenticação
  • Base URL: URL base da API Vezor

EvoApiClient

  • API Key: Chave de API específica da EvoAPI
  • Instance: ID da instância
  • Base URL: URL base da EvoAPI

KommoApiClient

Exemplos Avançados

Processamento de Mensagens em Lote

from vezor_sdk import EvoApiClient

evo_client = EvoApiClient(
    base_url="https://evoapi.vezor.cloud",
    instance="minha_instancia",
    api_key="minha_api_key"
)

# Obter mensagens com paginação personalizada
mensagens = evo_client.get_messages(offset=5000)

# Filtrar mensagens por tipo
mensagens_texto = [msg for msg in mensagens if msg.get('type') == 'text']
print(f"Mensagens de texto: {len(mensagens_texto)}")

Gerenciamento Completo de Pipeline Kommo

from vezor_sdk import KommoApiClient

kommo_client = KommoApiClient(
    base_url="https://minhaempresa.kommo.com",
    token="meu_token"
)

# Obter informações completas do pipeline
pipelines = kommo_client.get_pipelines()
for pipeline in pipelines:
    print(f"\n=== {pipeline['name']} ===")
    statuses = kommo_client.get_pipeline_statuses(pipeline['id'])
    for status in statuses:
        print(f"  - {status['name']}: {status['color']}")

Desenvolvimento

Instalação para Desenvolvimento

git clone https://github.com/vezor-group/vezor_sdk.git
cd vezor_sdk
pip install -e .

Executando Testes

python -m pytest tests/

Changelog

Veja o CHANGELOG.md para histórico de versões e mudanças.

Contribuindo

Contribuições são bem-vindas! Por favor, leia nossas diretrizes de contribuição antes de enviar pull requests.

  1. Fork o projeto
  2. Crie uma branch para sua feature (git checkout -b feature/AmazingFeature)
  3. Commit suas mudanças (git commit -m 'Add some AmazingFeature')
  4. Push para a branch (git push origin feature/AmazingFeature)
  5. Abra um Pull Request

Licença

Este projeto está licenciado sob a Licença MIT - veja o arquivo LICENSE para detalhes.

Suporte

Sobre a Vezor Technology

Somos uma empresa de tecnologia comprometida com o desenvolvimento democrático e acessível de soluções inovadoras. Acreditamos que a tecnologia deve ser uma ferramenta de transformação social, capaz de resolver problemas reais e criar oportunidades equitativas para todos.

Nossa missão é democratizar o acesso a tecnologias avançadas, desenvolvendo soluções que sejam simples de usar, economicamente acessíveis e tecnicamente robustas. Trabalhamos com Inteligência Artificial, integrações de sistemas, plataformas web e mobile, sempre priorizando a inclusão digital e o impacto social positivo.

Apoiamos o desenvolvimento de ecossistemas tecnológicos abertos e colaborativos, onde desenvolvedores, empresas e comunidades possam crescer juntos. Nossas ferramentas e SDKs são criados para facilitar a adoção de tecnologias emergentes, reduzindo barreiras técnicas e econômicas.

Conheça nosso Manifesto: https://about.vezor.cloud/


Desenvolvido pela equipe Vezor LABs

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vezor_sdk-0.1.2.tar.gz (9.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vezor_sdk-0.1.2-py3-none-any.whl (7.7 kB view details)

Uploaded Python 3

File details

Details for the file vezor_sdk-0.1.2.tar.gz.

File metadata

  • Download URL: vezor_sdk-0.1.2.tar.gz
  • Upload date:
  • Size: 9.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.12

File hashes

Hashes for vezor_sdk-0.1.2.tar.gz
Algorithm Hash digest
SHA256 a82404f48bc3dc1b9575b3f806fcf4d12ec159216f0ba88ed0a98efbf4d48fbd
MD5 15147b8df7eb89073f8a86932a8d6308
BLAKE2b-256 7e7e3cc2dd0633e138ce1151cf44d435dec81f3d5805e838475781bceaece486

See more details on using hashes here.

File details

Details for the file vezor_sdk-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: vezor_sdk-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 7.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.12

File hashes

Hashes for vezor_sdk-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a5d28a89d7216fb0b489d2af82704012e94e11e4a1a3708c2370a90883960a99
MD5 2a212ab286c4ea3f0ee83012eb3bc5c1
BLAKE2b-256 eacde8388f5665dd952a03445240e96b91ca07d3e6c81375ea608cb22c670abb

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page