tap-ixc¶
Biblioteca Python para sincronizar dados da API IXC Soft para PostgreSQL com checkpointing por stage, retry, circuit breaker e observabilidade nativa.
Declare os endpoints no clients.yml:
minha-empresa:
system: ixc
schema_name: public
postgres_dsn: "postgresql://user:pass@host/db"
api:
base_url: "https://sua.ixcsoft.com.br/webservice/v1"
token: "usuario:token"
endpoints:
- { name: clientes, api_endpoint: cliente, strategy: full }
- { name: titulos, api_endpoint: fn_areceber, strategy: delta, pk_column: id }
Como esta documentação é organizada¶
Seguimos o Diátaxis: quatro modos, cada um com um propósito.
-
Tutorial
Aprenda fazendo, do zero ao primeiro sync agendado.
-
Guias (how-to)
Receitas para tarefas concretas: adicionar stream, excluir campos, agendar.
Streams · Incremental · Deploy
-
Referência
Descrição precisa de cada campo, comando e classe.
Configuração · CLI · API
-
Explicação
Como funciona por dentro e por que as decisões foram tomadas.
Novo por aqui?¶
Comece pelo Tutorial de 10 minutos — você instala, configura e roda um sync real do começo ao fim. Depois volte aqui para aprofundar no que precisar.
O que torna o tap-ixc diferente¶
Não é mais um script de extração. As decisões de arquitetura que importam em produção — retomada por checkpoint, load atômico, circuit breaker por endpoint, cursor incremental, dead letter por linha — estão explicadas em Arquitetura. Se você quer entender por que antes do como, comece por lá.
Inspirado no Singer SDK (Meltano/Airbyte/Stitch) — veja o que herdamos e onde divergimos. Código aberto sob MIT.