Openi DeveloperDeveloper
Items

Ressincronizar Item

Força a ressincronização dos dados de uma conexão existente. Útil quando você precisa atualizar informações que podem ter mudado na instituição financeira.

Endpoint

Método e URL:

POST /v1/items/:id/resync

Parâmetros da URL:

  • id (string, obrigatório): Identificador único do item (UUID)

Quando Usar

Use este endpoint quando:

  • Suspeitar que os dados estão desatualizados
  • A instituição financeira reportar mudanças em contas ou transações
  • Quiser forçar uma sincronização manual
  • Houver inconsistências nos dados

Exemplo de Uso

Requisição:

POST /v1/items/01985c42-1234-5678-9abc-def123456789/resync

Resposta

Resposta de sucesso (200):

{
  "status": "success",
  "data": {}
}

Resposta de erro (404):

{
  "status": "error",
  "message": "Item not found."
}

Comportamento

Quando você chama este endpoint:

  1. Validação: O sistema verifica se o item existe
  2. Ressincronização: Inicia processo de atualização dos dados na instituição
  3. Processamento assíncrono: A ressincronização acontece em background
  4. Resposta imediata: O endpoint retorna sucesso mesmo que a sincronização ainda esteja em andamento

Monitoramento

Após solicitar a ressincronização:

  1. Use o endpoint Buscar Item para acompanhar o status
  2. Os dados atualizados estarão disponíveis nos endpoints específicos (contas, transações, etc.)
  3. Avisos ou erros de sincronização aparecerão no campo warnings do item

Limitações

  • A ressincronização é processada de forma assíncrona
  • Não há garantia de quando os dados estarão atualizados
  • Algumas instituições podem ter limites de frequência de sincronização
  • O item deve estar em status synced para ser ressincronizado

Notas

  • Este endpoint não retorna os dados sincronizados diretamente
  • Use com moderação para evitar sobrecarga no sistema
  • A ressincronização pode demorar alguns minutos dependendo da instituição
  • Consulte os endpoints específicos de dados após a ressincronização para ver as atualizações

On this page