General API
The General API allows you to view brand related information like Company Name, Logo URL, Currency, etc.
Get Configuration Details
This functionality allows you to fetch the brand details, defined in the automation platform.
HTTP Method
POST
Request URL
https://yourdomain.com/api/v2/user/configuration
Token
Token is required as an authentication parameter to get response from an API. Detailed Information about Tokens has been provided in the Authentication API Doc.
Request Headers
cache-control: no-cache, Validate: Bearer <Token> |
Parameters
Name | Data Type | Required/Optional | Description | Example |
settings | Array | Required | brand settings data | array('Telephone','Fax') |
pid | Integer | Optional | partner id | 0 |
For main venture, “partner id“ will be 0
Listed below are the possible values of settings:
Company Name
Default Email
Default From Email ID
Logo URL
Telephone
Fax
Address
Lamonor System URL
Record/Page
Date Format
Support Ticket Signature
Website URL
From Email Domain Name
Member Panel URL
Admin Panel URL
Zip Code
From Date
To Date
Privacy Policy URL
Allowed File Attachment Types
Facebook Link
Twitter Link
Google Plus Link
LinkedIn Link
Captcha key
Captcha secret key
Response
Returns a JSON response with details as shown below:
( Below displayed response is after decoding JSON )
Array
(
[Telephone] => +91-141-4133333
[Fax] => +91-141-4135553
) |
In case of any errors, an error code key with value along with an error message will be returned.
Get Base Currency Detail
This functionality allows you to fetch base currency related details, defined in the automation platform.
HTTP Method
POST
Request URL
https://yourdomain.com/api/v2/user/base_currency_detail
Token
Token is required as an authentication parameter to get response from an API. Detailed Information about Tokens has been provided in the Authentication API Doc.
Request Headers
cache-control: no-cache, Validate: Bearer <Token> |
Parameters
Name | Data Type | Required/Optional | Description | Example |
customer_id | Integer | Optional | customer id | 10415 |
pid | Integer | Optional | partner id | 0 |
mp_flag | Integer | Optional | To fetch all possible currency details | 1 |
Response
Returns a JSON response with details as shown below:
( Below displayed response is after decoding JSON )
Array
(
[id] => 1
[code] => INR
[prefix] => INR
[suffix] =>
[format] => 1234.56
[exchangerate] => 1.000000
[default] => 1
[pid] => 0
[roundvalue] => 5.00
[decimal_symbol] => .
[decimal_count] => 2
[grouping_symbol] => ,
[currency_position] =>
) |
Array
(
[0] => Array
(
[id] => 1
[prefix] => ₹
[default] => 1
)
[1] => Array
(
[id] => 2
[prefix] => USD
[default] => 0
)
)