Vivaintra API para Integração (1.1.2)

Download OpenAPI specification:Download

Introdução

Sabemos que manter a base de usuários em ambientes distribuídos é um dos desafios das implantações de sistemas. E por isso, a API em sua primeira versão, disponibiliza recursos para garantir essa integração.

Esta API é um serviço fornecido pela VivaIntra para seus clientes para integrar sua base de usuários (colaboradores) presente em seus softwares à nossa aplicação.

O que faz esta API?

  • Cria registros para novos usuários
  • Atualiza dados de registros existentes
  • Atualiza status (inativação) de usuários
  • Atualiza fotos dos usuários (avatar)

Todos têm acesso a esta API?

  • Todos os clientes do plano enterprise (nuvem ou in-house)

Todos os usuários têm acesso a esta API?

  • Não, somente os papéis que tiverem permissão para "gerenciar integração"
  • Para saber mais, acesse Painel Administrador / Permissões / Integração

Além da API, quais são as outras integrações disponíveis?

  • Integração Active Directory (pelo painel administrador e protoloco LDAP/LDAPS)
  • Integração HTTPS (por requisição automaticamente agendada)
  • Integração de Login com SSO Active Directory (agente local em servidor Windows Server)
  • Integração de Login com SSO (agente própria customizável com sistema de terceiro em ambiente in-house)
  • Integração de Login com Google e Agenda
  • Integração de Login com Outlook e Agenda

Como saber mais e obter documentações sobre as integrações disponíveis através do ambiente administrativo?

Como começar a usar esta API e testar seu funcionamento?

  • Teste a requisição de Autenticação e consiga um retorno de sucesso com um Token
  • Lembre-se que a autenticação é temporária e se for agendar algum processo interno, sempre execute a autenticação antes das suas requisições entre períodos distintos
  • Entenda como está estruturado nosso arquivo de CSV para integração de dados
  • Construa um CSV manualmente com um ou dois usuários e teste a requisição
  • Se desejar que a integração desative usuários, teste também este cenário
  • Por fim, execute a requisição de atualização de fotos (que não é em lote) e tudo estará correto.
  • Qualquer dúvida, você pode acionar nosso suporte em suporte@vivaintra.com

C