Giter VIP home page Giter VIP logo

ventana's Introduction

Ventana Build Status Coverage Status Sauce Test Status

Ventana is a client to help connecting and making requests to a SugarCRM REST API on multiple versions.

Currently this library provides a JavaScript connector.

Alternatively, a PHP connector is available here.

Please contribute to help us grow this client connector.

Sauce Test Status

Usage example

You just need to require the module and create an instance of the Api class:

    const Ventana = require('@sugarcrm/ventana');
    const SugarApi = Ventana.getInstance({
        serverUrl: app.config.serverUrl,
        platform: app.config.platform,
        timeout: app.config.serverTimeout,
        clientID: app.config.clientID,
    });

    // Fetch the app metadata
    SugarApi.getMetadata();

    // Fetch `Accounts` records
    SugarApi.records('read', 'Accounts');

    // Favorite a specific contact
    SugarApi.favorite('Contacts', <recordId>, true);

You can find the full documentation here.

Contributing

See Contributing guidelines.

ventana's People

Contributors

alias-mac avatar dtam avatar pbeets avatar piterfm avatar dszczesny avatar jgirault avatar rhoggsugarcrm avatar sparsley avatar ssheshadri avatar mmarum-sugarcrm avatar roblevintennis avatar yli-sugarcrm avatar bor0 avatar james-sugar avatar jimmychen avatar mitani avatar yvan33 avatar smalyshev avatar ebychkov-sugarcrm avatar lamhuynh avatar jbartek avatar cwang-sugar avatar robertgonzalez avatar sugarhqi avatar f1vlad avatar morozov avatar jcsmorais avatar axyjo avatar agoropeka-sugarcrm avatar yellowandy avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.