WeChat mini-program API
Basic tools to integrate Odoo and WeChat mini-program.
Payment method
Mini program uses Official Account Payment method. For more information, please see the WeChat Pay Interface Document
Developing mini-program
Authentication
To authenticate a user from the mini-program, you must send a request with a code and user information of the mini-program to the server. To receive the code and send the request, you must use wx.login provided by mini-program API. Odoo will create a user if one does not exist and assign session_id which has to be sent via a cookie on each RPC request.:
function AuthenticateUser(code) {
return new Promise(function(resolve, reject) {
var userInfo = app.globalData.userInfo;
code = code || false;
function do_request() {
var options = {
url: 'https://ODOO_HOST/itp_wechat/miniprogram/authenticate',
header: {
'Content-Type': 'application/json'
},
success: function(res) {
// save session_id
var data = res.data.result;
if (data.session_id) {
wx.setStorage({
key: 'session_id',
data: data.session_id,
success: function() {
resolve(data);
}
})
} else {
reject(res);
}
},
fail: function(res) {
reject(res);
}
};
var params = {
context: {
},
code: code,
user_info: userInfo
};
// send request to Odoo server
wxJsonRpc(params, options);
}
if (code) {
do_request();
} else {
wx.login({
success: function(data) {
code = data.code;
do_request();
}
})
}
});
}
RPC calls
RPC request from mini-program:
function odooRpc(params, options) {
return new Promise(function(resolve, reject){
options = options || {
};
function do_request(session_id) {
options.url = 'https://ODOO_HOST/web/dataset/call_kw';
options.header = {
'Content-Type': 'applications/json',
'X-Openerp-Session-Id': session_id
};
options.success = function(res) {
var data = res.data.result;
resolve(data);
};
options.fail = function(res) {
reject(res);
};
wxJsonRpc(params, options);
}
wx.getStorage({
key: 'session_id',
success: function(res) {
if (res.data) {
do_request(res.data);
} else {
AuthenticateUser().then(function(data){
do_request(data.session_id);
});
}
},
fail: function() {
AuthenticateUser().then(function(data){
do_request(data.session_id);
});
},
});
});
}
function wxJsonRpc(params, options) {
var data = {
"jsonrpc": "2.0",
"method": "call",
"params": params,
"id": Math.floor(Math.random() * 1000 * 1000 * 1000),
}
options.data = JSON.stringify(data);
options.dataType = 'json';
options.method = 'POST';
// send request to Odoo server
wx.request(options);
}
Example: Load Products from Odoo Server:
var params = {
models: 'product.product',
method: 'search_read',
args: [
],
context: {
},
kwargs: {
domain: [['sale_ok','=',true],['available_in_pos','=',true]],
fields: ['display_name', 'list_price', 'lst_price', 'standard_price', 'categ_id', 'pos_categ_id', 'taxes_id',
'barcode', 'default_code', 'to_weight', 'uom_id', 'description_sale', 'description',
'product_tmpl_id','tracking'],
}
}
odooRpc(params).then(function(res) {
console.log(res);
});
Result: list of Products
Sandbox & Debugging of mini-program
- API Debug Console https://open.itp_wechat.com/cgi-bin/newreadtemplate?t=overseas_open/docs/oa/basic-info/debug-console
- Creating Test Accounts https://admin.itp_wechat.com/debug/cgi-bin/sandbox?t=sandbox/login
- You will get sub_appid and sub_appsecret values for work with mini-programs
Questions?
To get an assistance on this module contact us by email apps@it-projects.info
Contributors
- Dinar Gabbasov
| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Odoo Apps Dependencies |
Discuss (mail)
|
| Community Apps Dependencies | Show |
| Lines of code | 925 |
| Technical Name |
itp_wechat_miniprogram |
| License | See License tab |
| Website | https://it-projects.info |
WeChat mini-program API
Follow instructions of WeChat API module.
Installation
Multi database
If you have several databases, you need to check that all requests are sent to the desired database. The user authentication request from the Mini-program does not contain session cookies. So, if Odoo cannot determine which database to use, it will return a 404 error (Page not found). In order for the requests to send to the desired database, you need to configure dbfilter.
Configuration
Credentials
- Activate Developer Mode
- Open menu [[ Settings ]] >> Parameters >> System Parameters
- Create following parameters
- itp_wechat.miniprogram_app_id
- itp_wechat.miniprogram_app_secret
The MIT License (MIT) Copyright 2020 IT-Projects Labs Copyright 2015-2020 IT-Projects LLC Copyright 2014-2015 Ivan Yelizariev Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Please log in to comment on this module