APIs VTAP: capacitando desenvolvedores a simplificar, recuperar e inovar perfeitamente

As APIs do VTAP fornecem funções poderosas que permitem aos desenvolvedores recuperar, atualizar e gerenciar dados com eficiência, além de executar uma variedade de operações sem problemas.

Nesta edição, damos-lhe os seguintes exemplos:

  • Atualizar um registro usando
  • Recarregar visualização de lista
  • Recuperar os detalhes da função do usuário conectado no momento
  • Recuperar os detalhes da função de usuários específicos

Atualizar um registro usando a API VTAP para recarga automática de dados

As alterações não aparecerão automaticamente no front-end quando os detalhes do registro forem atualizados usando os métodos POST ou PUT. Isso ocorre porque esses métodos atualizam os dados no lado do servidor, mas o front-end não busca automaticamente os dados mais recentes, a menos que explicitamente instruído a fazê-lo. Para garantir que os detalhes atualizados sejam refletidos no front-end, a página precisa ser recarregada.

Podemos atualizar dinamicamente o registro usando a API VTAP sem a necessidade de recarregar páginas manualmente.

API: VTAP.Detail.RefreshRecord(); 

Exemplo:


  

VTAP.Api.Put('records', {

module : ‘module_name’, 

id : ‘record_id’, 

field_name : ‘field_value’,

}, (error, response) => {                    

 If (response) {                        

VTAP.Detail.RefreshRecord();                         VTAP.Utility.ShowSuccessNotification("Record Updated Successfully.");                    

}

 });


  

VTAP.Api.Put('records', {

module : ‘module_name’, 

id : ‘record_id’, 

field_name : ‘field_value’,

}, (error, response) => {                    

 If (response) {                        

VTAP.Detail.RefreshRecord();                         VTAP.Utility.ShowSuccessNotification("Record Updated Successfully.");                    

}

 });

Link de referência do documento: https://vtap.vtiger.com/platform/resources/vtap-js.html#vtap-detail-refreshrecord

Recarregar a visualização de lista usando a API VTAP

Quando um novo registro é criado por meio da API VTAP a partir de uma interface de exibição de lista, a exibição de lista não é atualizada automaticamente para mostrar o registro recém-adicionado. Em vez disso, o usuário precisa recarregar manualmente a página para ver os dados mais recentes.

A API VTAP atualiza a Visualização de Lista dinamicamente sem exigir uma recarga manual da página.

API: VTAP.List.Reload();

Exemplo:


  

VTAP.Api.Post('records', {

module : 'Contacts', 

firstname : 'John',

lastname : 'Wick', 

'email' : '[email protected]'

}, (error, response) => {

     If (response) {                        

VTAP.Utility.ShowSuccessNotification("Record Created Successfully.");  

VTAP.List.Reload();                  

}

});


  

VTAP.Api.Post('records', {

module : 'Contacts', 

firstname : 'John',

lastname : 'Wick', 

'email' : '[email protected]'

}, (error, response) => {

     If (response) {                        

VTAP.Utility.ShowSuccessNotification("Record Created Successfully.");  

VTAP.List.Reload();                  

}

});

Link de referência do documento: https://vtap.vtiger.com/platform/resources/vtap-js.html#reload

Recupere os detalhes da função do usuário conectado no momento usando a API VTAP

Uma API VTAP está disponível para recuperar os detalhes do usuário atualmente logado. Esta API recupera detalhes do usuário, como detalhes pessoais, preferências ou dados relacionados ao sistema.

Entre as informações retornadas por esta API, há um foco específico nos detalhes da função do usuário. 

Ao usar esta API, os desenvolvedores podem integrar perfeitamente funcionalidades específicas do usuário e garantir autorização adequada e experiências personalizadas com base na função do usuário.

URL da API: "mim"

Exemplo:


  

VTAP.Api.Get('me', {

'module': 'Users'

}, (error, response) => {

If (response) {

const roleInfo = response.roleid;

         console.log(roleInfo.id); // Logs the role ID

         console.log(roleInfo.label); // Logs the role name

}

});


  

VTAP.Api.Get('me', {

'module': 'Users'

}, (error, response) => {

If (response) {

const roleInfo = response.roleid;

         console.log(roleInfo.id); // Logs the role ID

         console.log(roleInfo.label); // Logs the role name

}

});

Recupere os detalhes da função de usuários específicos usando a API VTAP

Você pode recuperar informações de função para um usuário específico usando a API VTAP fornecendo o ID do usuário como um parâmetro.

Exemplo:


  

VTAP.Api.Get('records', {

'module': 'Users',

‘Id’: ‘user_id’

}, (error, response) => {

If (response) {

const roleInfo = response.roleid;

         console.log(roleInfo.id); // Logs the role ID

         console.log(roleInfo.label); // Logs the role name

}

});


  

VTAP.Api.Get('records', {

'module': 'Users',

‘Id’: ‘user_id’

}, (error, response) => {

If (response) {

const roleInfo = response.roleid;

         console.log(roleInfo.id); // Logs the role ID

         console.log(roleInfo.label); // Logs the role name

}

});

 
 

Inscreva-se para receber as últimas atualizações!