Giter VIP home page Giter VIP logo

wellteq-node-mautic's Introduction

node-mautic

A Node.js Mautic API implemented with ES6 + async/await.

Tested with Node 14 and Mautic 3.1.2. (Should work with Node 10 and Mautic 2.7.x as well.)

This package has only 1 dependency (node-fetch), which has 0 dependencies.

Installation

$ npm install node-mautic

Usage

  1. Require the class

    const MauticConnector = require('node-mautic');
  2. Instantiate the object

    const mauticConnector = new MauticConnector({
        apiUrl: 'https://your-url.com',
        username: '...',
        password: '...' ,
        timeoutInSeconds: 5
    });
    • apiURL needs to be just the base URL. The /url/ part of the API URL is to be omitted here.
    • username and password are just a normal Mautic user's username and password. There are no separate API users in Mautic.
    • timeoutInSeconds is optional.
  3. Make calls

    Example:

    const campaigns = (await mauticConnector.campaigns.listCampaigns()).campaigns;

Features

  • uses basic authentication
  • has methods for all ~200 documented API endpoints
  • has less than 400 lines of code
  • uses async/await (no callback hell)
  • some documentation
  • 6 Jest tests

Links

Tests

To run the tests, fill the apiUrl, username, and password fields in MauticConnector.i.test.js.

Thanks

wellteq-node-mautic's People

Contributors

vdavid avatar pushparajsamant avatar dependabot[bot] avatar theavijitsarkar avatar r3volut1oner avatar syrok avatar vettloffah avatar gramakri avatar leog avatar si4dev 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.