Module Zapier

From Dolibarr ERP CRM Wiki
Jump to navigation Jump to search
Zapier
Numéro/ID du module 50330
Doc utilisateur du module This page
Doc développeur du module Module Zapier (developer)

Introduction

This module is to manage links between Dolibarr and Zapier.

Installation

This module is included with the Dolibarr distribution, so there is no need to install it.

Configuration

To use this module, you must first enable it using an administrator account, via the menu option "Home - Setup - Modules".

Choose the tab where the module is listed. Then click on "Activate".

The module is now activated.

If a cog icon appears Cog circle.svg at end of line of the module, click on it to access the setup page specific to the module.


Create a Zapier developper account

At first, you need to have a Zapier developper account, create it here: Zapier Platform

Build and Deploy the "Zapier App" on Zapier platform

The Zapier App is a small package in javascript you have to deploy on Zapier so Zapier will be able to speak the language of your Dolibarr application.

Install Node.js

An easy option to get set up with Node.js is to visit [1](https://nodejs.org/en/download/) and download the official installer for your OS. If you're installing with a package manager it's even easier.

After installation, confirm that Node.js is ready to use:

node --version

Install the Zapier CLI

Next let's install the zapier CLI tools. This CLI utility will allow you to build your app, deploy it to the Zapier platform, do local testing, manage users and testers, view remote logs, collaborate with your team, and more:

cd dev/examples/zapier
npm install zapier-platform-cli
zapier --version

Run Zapier Login

Let's configure authentication between your dev environment and the Zapier platform. You'll use the email address and password you use to log in to the Zapier application.

zapier login

This command will set up a .zapierrc file in your home directory.

Install the Project

In zapier examples directory, run:

cd dev/examples/zapier
npm install

Deploying your App

Let's deploy it! When you're ready to try your code out on the Zapier platform use the push command. Only you will be able to see the app until you invite testers.

zapier register   (the first time, choose name for example "My Dolibarr")
zapier push

After a push, the Application, with the name you defined during the register step, is available as a Private Application when creating a Zap.

You will find original tutorial here : [2](https://zapier.com/developer/start/introduction)

Usage

Creating a connection for the App

Enable the REST API in Dolibarr. They are used by Zapier, starting with the login API.

Go into Zapier dashboard and create a Connection: Go into "My Apps - Custom integration", then "Add Connection".

If the App does not appear into list to add a connexion, forget this step and to to create a Zap directly, the connection creation may be asked later). If the Connection can be created, enter the URL of your Dolibarr Login page.

Enter the login / pass of an existing account.

  • For authentication, you must enter the login / pass of an existing account that will be used by Zapier to call APIs. Give the permission to this user according to the action that Zapier will ask to your Dolibarr.
  • If you have a SSL certificate error when accessing your web site because of an auto-signed certificate, you can disable SSL certificate check from Zapier Settings - Advanced setting.
  • If you web instance is protected by a HTTP Basic protection, you must keep the public URLs opened for external tool. This is a sample of the directive to use to exclude some pages to the HTTP Basic protection
        #leaving /public and /api and /dav accessible to everyone
        <Directory /homedirofproject/htdocs/public/>
        AuthType None
        Require all granted
        Satisfy any
        </Directory>
        <Directory /homedirofproject/htdocs/api/>
        AuthType None
        Require all granted
        Satisfy any
        </Directory>
        <Directory /homedirofproject/htdocs/dav/>
        AuthType None
        Require all granted
        Satisfy any
        </Directory>
        <Directory /homedirofproject/htdocs/.well-known/>
        AuthType None
        Require all granted
        Satisfy any
        </Directory>
        <Files ~ "(document\.php|viewimage\.php|\.js\.php|\.json\.php|\.js|\.css\.php|\.css|\.gif|\.png|\.svg|\.woff2|favicon\.ico)$">
        AuthType None
        Require all granted
        Satisfy any
        </Files>

Create a Zap

Create a ZAP that use the application you registered from the Zapier interface https://www.zapier.com