Methods Reference

3.1 - Initiate the connection

Init the connection to MBurger with your API Key.
1
const instance = mburger.createClient({
2
api_key: '1234567890'
3
});
Copied!

3.2 - Retrieve a single Section

Specification
Data Type
Description
section_id
Integer
ID of the requested Section
original_media
Boolean
Indicate if you want the original media or the converted ones
use_slug
Boolean
Declare if you want to use the section slug instead of the ID to retrieve data
locale
String
Country code of the required locale
3.2.1 - Sample code
1
// Import MBurger SDK
2
const mburger = require('mburger');
3
4
// Init the connection
5
const instance = mburger.createClient({
6
api_key: '1234567890'
7
});
8
โ€‹
9
// Get a specific block
10
instance.getSection({
11
section_id: 10088,
12
locale: 'it',
13
original_media: false
14
}).then(result => console.log(result));
Copied!

3.3 - Retrieve a single Block

Specification
Data Type
Description
block_id
Integer
ID of the requested Block
force_locale_fallback
Boolean
Set the parameters force_locale_fallback as indicated in the documentation
locale
String
Country code of the required locale
original_media
Boolean
Indicate if you want the original media or the converted ones
params
Object
The parameters you want to pass to the MBurger params variable. Check our API Reference for more informations
order_asc
Boolean
Declare if you want the data in ascendent or descendent order
3.3.1 - Sample code
1
// Import MBurger SDK
2
const mburger = require('mburger');
3
4
// Init the connection
5
const instance = mburger.createClient({
6
api_key: '1234567890'
7
});
8
โ€‹
9
// Retrieve a specific block
10
instance.getBlock({
11
block_id: 884,
12
locale: 'it',
13
original_media: false
14
}).then(result => console.log(result));
Copied!

3.4 - Retrieve multiple Blocks

Specification
Data Type
Description
block_ids
Array
ID of the requested Blocks
filters
Object
The filters you want to pass to the MBurger params variable. Check our API Reference for more informations
order_asc
Boolean
Declare if you want the data in ascendent or descendent order
3.4.1 - Sample code
1
// Import MBurger SDK
2
const mburger = require('mburger');
3
โ€‹
4
// Init the connection
5
const instance = mburger.createClient({
6
api_key: '1234567890'
7
});
8
โ€‹
9
// Retrieve data from the block
10
instance.getBlocks({
11
block_ids: [884, 886],
12
locale: 'it'
13
}).then(result => console.log(result));
Copied!

โ€‹

Last modified 11mo ago
Copy link
Contents