setyongr / b24 Goto Github PK

View Code? Open in Web Editor NEW

20.0 7.0 16.0 41 KB

Bitrix24 Client Library

License: MIT License

TypeScript 40.38% JavaScript 59.62%

library bitrix bitrix24

b24's Introduction

Bitrix24 Client Library

Installation

npm install b24 --save

Modes

There are 2 modes to use this library. API mode and Webhook mode.

You can specify the mode when initializing Bitrix24.

API Mode

When you use API mode, you must authenticate the user using OAuth. See Authentication for example. You also must provide client_id, client_secret, and redirect_uri in config block.

Method Hook

There are 2 method that will called when using API mode. saveToken(data) and retriveToken. You can use this to save and get token from database.

Example

const b24 = require('b24');

const bitrix24 = new b24.Bitrix24({
    config: {
        mode: "api",
        host: "your bitrix host",
        client_id : "your client id",
        client_secret : "your client secret",
        redirect_uri : "http://localhost:3000/callback"
    },
    methods: {
        async saveToken(data){
            //Save token to database
        },
        async retriveToken(){
            //Retrive token from database
            return {
                access_token: "youraccesstoken",
                refresh_token: "yourrefreshtoken"
            }
        }
    }
})

Webhook Mode

It use webhook feature from Bitrix24 To use this you must provide user_id and code in config block.

user_id can be obtained throught my profile page. See the URL, e.g https://k2d2.bitrix24.com/company/personal/user/4/. The value would be 4

code can be obtained throught Application -> Web hooks -> ADD WEB HOOK -> Inbound web hook

Example

const b24 = require('b24');

const bitrix24 = new b24.Bitrix24({
    config: {
        mode: "webhook",
        host: "your bitrix host",
        user_id: "1",
        code: "your_webhook_code"
    }
})

Authentication

You must do authentication when use API mode. It just OAuth2

Step:

Visit url provided by bitrix24.auth.authorization_uri
It will give you the code in callback url, use this to get token
Get token with bitrix24.auth.getToken(code)
Profit!!!

Example:

const express = require('express');
const b24 = require('b24');

const app = express()

const bitrix24 = new b24.Bitrix24({
    config: {
        mode: "api",
        host: "your bitrix host",
        client_id : "your client id",
        client_secret : "your client secret",
        redirect_uri : "http://localhost:3000/callback"
    },
    methods: {
        async saveToken(data){
            //Save token to database
        },
        async retriveToken(){
            //Retrive token from database
            return {
                access_token: "youraccesstoken",
                refresh_token: "yourrefreshtoken"
            }
        }
    }
})

// Bitrix auth
app.get('/auth', (req, res) => {
    res.redirect(bitrix24.auth.authorization_uri);
});

// Callback service parsing the authorization token and asking for the access token
app.get('/callback', async (req, res) => {
    try{
        const code = req.query.code;
        const result = await bitrix24.auth.getToken(code);
        return res.json(result);
    }catch(err){
        console.log(err)
        return res.status(500).json({message:"Authentication Failed"});
    }
});

app.listen(3000, () => {
    console.log('Server started on port 3000');
});

Run Bitrix24 API

For complete API refrence visit https://training.bitrix24.com/rest_help/index.php

To Run Bitrix24 API we need to use callMethod(method, param) method.

pass the method you want to run in method parameter, param parameter is optional, it used to add parameter to method that you call, visit the official API reference to see all possible parameter.

Example:

const express = require('express');
const b24 = require('b24');

const app = express()

const bitrix24 = new b24.Bitrix24({
    config: {
        mode: "webhook",
        host: "your bitrix host",
        user_id: "1",
        code: "your_webhook_code"
    }
})

// Get all Bitrix24 User
app.get('/allUser', async (req, res) => {
    try{
        const result = await bitrix24.callMethod('user.get');
        return res.json(result);        
    }catch(err){
        console.log(err)
        return res.status(500).json({message:"Internal Server Error"});
    }
})

app.listen(3000, () => {
    console.log('Server started on port 3000');
});

b24's People

Contributors

Stargazers

Watchers

Forkers

wisn tarasalk sitnickoff lamnot macromindonline awesomebitrix renanbatel joelciomatias senegoid gor-eugene nikolaytach stis91 koncaq saikarthikp9 alladin7000 imnebo

b24's Issues

Use another QS library

When we send a find method, the "querystring" native package can't handle nasted objects.

I'll send a pull request with a new "qs" package installation dependency to correct it.

Getting error: "ksAndRejections (node:internal/process/task_queues:83:21) [ERROR] 10:53:02 StatusCodeError: 400 - "{\"error\":100,\"error_description\":\"Invalid value {} to match with parameter {fields}. Should be value of type array.\"}""

Trying to make a mutation with list like this:

and getting error:

Parameter <any param> must be array.

Hello.
https://training.bitrix24.com/rest_help/crm/contacts/crm_contact_list.php
Any example I'm trying to use, I get an error with Parameter 'param' must be array.

bitrix24.callMethod("crm.contact.list", {
  order: { "DATE_CREATE": "ASC" },
  filter: { "TYPE_ID": "CLIENT" },
  select: [ "ID", "NAME", "LAST_NAME", "TYPE_ID", "SOURCE_ID" ]
});

Is there any difference between this library and the library used in the documentation examples?

Anybody currently using the webhook method?

Unable to resolve module `querystring` from `../../node_modules/b24/dist/index.js`

when I implement this library, the project displays this error Unable to resolve module 'querystring'. from '/../../node_modules/b24/dist/index.js' . please resolve this error

Unable to call B24 from external Library

Hi baws,
I have tried everything i can but can't get to call the methods from inside my libray, kindly have a look

const express = require('express');
const b24 = require('b24');
const app = express();
var ethers = require('ethers');

// Connect to the network
var providers = require('ethers').providers;
var network = providers.networks.ropsten;
// Connect to a local Parity instance
var provider = new providers.JsonRpcProvider('http://localhost:8545', network);

const bitrix24 = new b24.Bitrix24({
config: {
mode: "api",
host: "xxxxxxxxx",
client_id : "local.cccccccccccccccccccccccccc",
client_secret : "dddddddddddddddddddddddddddd",
redirect_uri : "http://localhost:3000/callback"
},
methods: {
async saveToken(data){
//Save token to database
},
async retriveToken(){
//Retrive token from database
return {
access_token: "youraccesstoken",
refresh_token: "yourrefreshtoken"
}
}
}
})

// Get notified when a contract event is logged
var eventTopic = '0xf538d33cf0aeab2f474d1ec307854fed7e411946cb8e4239785e4f7d2c424047';
provider.on([ eventTopic ], function(log) {
console.log('Event Log');
console.log(log);
var Call = log;

// Bitrix auth
app.get('/auth', (req, res) => {
res.redirect(bitrix24.auth.authorization_uri);
});

// Callback service parsing the authorization token and asking for the access token
app.get('/callback', async (req, res) => {
try{
const code = req.query.code;
const result = await bitrix24.auth.getToken(code);
return res.json(result);
}catch(err){
console.log(err)
return res.status(500).json({message:"Authentication Failed"});
}
});

// if (Call == "xxxxxxx") {

app.get('/allUser', async (req, res) => {
try{
const result = await bitrix24.callMethod('user.add', {"EMAIL": "[email protected]"});
return res.json(result);
}catch(err){
console.log(err)
return res.status(222).json({"result":222});
}
});
});

app.listen(3000, () => {
console.log('Server started on port 3000');
});

setyongr / b24 Goto Github PK

b24's Introduction

Bitrix24 Client Library

Installation

Modes

API Mode

Method Hook

Example

Webhook Mode

Example

Authentication

Run Bitrix24 API

b24's People

Contributors

Stargazers

Watchers

Forkers

b24's Issues

Recommend Projects

Recommend Topics

Recommend Org