Webservices Rest API VTcrm

Aproveite as APIs REST expostas por HTTP(s) para enviar ou extrair dados do VTcrm e integrar-se a aplicativos de terceiros. Você certamente é livre para escolher a biblioteca de sua preferência para trabalhar com essas API.

A documentação desta API pode ser vista no PostMan.

Formato de solicitação

HTTP – GET / POST

application/x-www-form-urlencoded

Formato de resposta

Sucesso

{
        success: true,
        result: {
                // ...
        }
}

Falha

{
        success: false,
        error: {
                message: String,
                code:    String
        }
}

Operação de Login

É um processo de duas etapas que envolve obter o token de desafio e trocar as credenciais (nome de usuário e accessKey). Você pode encontrar informações de accessKey em “Minhas preferências” na interface do usuário da Web do CRM.

Request

GET /webservice.php?operation=getchallenge&username=<USERNAME> HTTP/1.1

Resposta

{
        success: true,
        result: {
                token: TOKENSTRING,    // Token para uso no login.
                serverTime: TIMESTAMP, // Servidor timestamp
                expireTime: TIMESTAMP  // Timestamp de validade do Token
        }
}

Login

Request

POST /webservice.php HTTP/1.1

operation=login
username=<USERNAME>
accessKey=md5(TOKENSTRING + <ACCESSKEY>) 

Resposta

{
        success: true,
        result: {
                sessionId:      String, // Id da sessão
                userId:         String, // User ID no CRM
                version:        String, // Versão do Webservice API 
                vtigerVersion:  String  // Versão do VTcrm        }
}

Logout

Request

POST /webservice.php HTTP/1.1

operation=logout
sessionName=sessionId // Obtido na operação de Login

Resposta

{
        success: true,
        result: {
                sessionId:      String, // Id da sessão
                userId:         String, // User ID no CRM
                version:        String, // Versão do Webservice API 
                vtigerVersion:  String  // Versão do VTcrm        }
}

Suporte e dúvidas

Para tirar dúvidas na implantação da API, ou a necessidade de acesso ao um sistema de teste, favor enviar um e-mail para suporte@nabile.dev com o titulo: [SUPORTE] API VTcrm