DMS API Document 1
Objective
The objective of this document is to help the end users access the DMS API to download
data from DMS. This document covers the below listed modules for downloading data from
DMS.
1. Purchase Order
2. Sales Order
3. Monthly Journey Plan
4. Market Working
Steps
Below are the steps included in authenticating APIs and downloading data from the DMS.
Step 1: Authentication level 1
API URL: https://vistony.forumnxt.com/cmf-
1.0.0/auth/VIST2021/Authentication?format=extjson
Method: Get
Access the above API URL to get auth token and dynamic salt value from DMS server. The
API will give the details in the JSON format below.
{
"collections": {
"authentication": {
"authtoken": "eba0ad53e5934d8020bc0f95afafed04",
"dynasalt": "aca05577f792ef8b4dac9947d418e2ff"
},
"rowcount": ""
}
}
Step 2: Authentication level 2
API URL : https://vistony.forumnxt.com/cmf-
1.0.0/auth/VIST2021/Authentication?format=extjson&auth_token=eba0ad53e5934d8020b
c0f95afafed04
Method: Post
The auth token returned by the level 1 authentication API should be passed as the input for
the authentication level 2 parameter “auth_token”.
DMS API Document 2
Payload: The JSON data below should be shared as the payload for authentication level 2.
{
"collections": {
"authentication": {
"cdkey": "352QO-QKMXT-GSUEX-GFSUD-EVAB4",
"client_version": "VistonyPeruDownload",
"clientid": "VIST2021",
"deviceuniquekey": "1234567",
"ldapentitytype": "distributorprofile"
}
}
}
The API will return the below JSON which will have the API key value and the username. The
response JSON data can be referred below.
{
"collections": {
"authentication": {
"cdkey": "352QO-QKMXT-GSUEX-GFSUD-EVAB4",
"client_version": "VistonyPeruDownload",
"clientid": "VIST2021",
"deviceuniquekey": "1234567",
"ldapentitytype": "distributorprofile"
}
}
}
Step 3: Access the count API of the respective module
Sample URL: https://vistony.forumnxt.com/cmf-
1.0.0/esb/VIST2021/mobile/pocount?format=extjson&auth_token=eba0ad53e5934d8020bc0f95afafed04&authusernam
e=undefinedVIST2021352QO-QKMXT-GSUEX-GFSUD-
EVAB41234567&api_key=da6349118e6c341ca565e5614418cf0b&aclrole=distributor&origin=sp&dest=sp&offset=0&sdt
=2024-01-30%21:34:19
The “auth_token”, “authudername”, “api_key” parameters should refer to the output from
the authentication level 2 response.
The “sdt” parameter should have the data and time from which the data is to be downloaded
from DMS.
The API will share the number of records available for download as the output. The output
will be in the JSON format available below.
{
"collections": {
"response": {
"pocount": "1"
DMS API Document 3
},
"rowcount": "1"
}
}
Step 4: Access the data download API
Sample URL: https://vistony.forumnxt.com/cmf-
1.0.0/esb/VIST2021/mobile/po?format=extjson&auth_token=9b3852368063950a74572ba
c3fa5746e&authusername=undefinedVIST2021352QO-QKMXT-GSUEX-GFSUD-
EVAB41234567&api_key=008a1a524405a371233f9f9de164fc89&aclrole=distributor&origi
n=sp&dest=sp&limit=100&offset=0&sdt=2024-01-30%21:34:19
The “auth_token”, “authudername”, “api_key” parameters should refer to the output from
the authentication level 2 response.
The “sdt” parameter should have the data and time from which the data is to be downloaded
from DMS.
The “limit” parameter should have the number of details records data to be downloaded
from DMS in a single request. The “offset” parameter should have the offset value of the
total number of records.
The detailed data will be downloaded in the JSON format below.
{
"collections": {
"response": {
"SNO": "1",
"po_id": "PO83",
"dist_code": "DEMO1",
"dist_channel_code": "CH1",
"dist_channel_desc": "All Channels",
"transaction_number": "PO02Jul202400003",
"reference_number": "",
"vendor_code": "VEN23",
"duedate": "2024-07-02",
"carrier": "",
"total": "35880.6",
"total_discount_percent": "0",
"total_discount_amount": "0",
"shipping_handling_charges": "0",
"terms_conditions": "",
"purchase_order_date": "2024-07-02",
"purchaseorder_no": "PO83",
"depotcode": "DPT1",
"depotname": "Rajasthan",
"productcode": "1018026",
"sequence_no": "1",
"suggested_reorder_qty": "0",
DMS API Document 4
"suggested_base_reorder_qty": "0",
"quantity": "1",
"uomname": "Units",
"listprice": "35880.600000",
"line_discount_percent": "0",
"line_discount_amount": "0",
"tax": "0",
"datetime": "2024-12-02 16:53:18",
"active": "1",
"creatdate": "2024-07-02 15:32:41",
"incrementflag": "2",
"billing_address": "CODE",
"shipping_address": "CODE",
"approval_name": "gaurav"
},
"rowcount": "1"
}
}
API Details
Authentication levels 1 & 2 APIs are common for all the data downloads, the count and
details download APIs will be unique for each module, please find the API names below.
S# Module Name Count API Details API
1 Purchase Order pocount po
2 Sales Order sorcount sor
3 Monthly Journey Plan Jpcount jp
4 Market Working marketworkingcount marketworking
