ERP API

Integrate any ERP with the mobile applications by sending and receiving sync packets

Push Sync Packet

GET https://api.portal.dynamicsmobile.com/erp/push/:appArea/:mobileUser

The API is used by the ERP systems to send synchronization packet for specific mobile user. The packet is processed and converted to native mobile data storage format. The mobile user receives push notification that new data is pending, so the user may start the synchronization process from the mobile app.

Path Parameters

Name	Type	Description
appArea	string	The application area code
mobileUser	string	The name of the mobile user, who sends the data packet

Query Parameters

Name	Type	Description
packetUniqueId	string	Unique identifier of the packet. Stored in the cloud and can be used for tracing/issue resolution
size	number	The size of the sync packet in bytes
packetType	string	the format of sync packet content: xml or json

Headers

Name	Type	Description
Content-Type	string	Must have "application/json" value
x-api-key	string	The api key for the application area

200 The response is json containing the following fields: - success: boolean - must contain true if the packet temporary upload link is successfully obtained - syncLogId: string - contains the unique identifier of the syncpacket in the cloud. Can be used for tracing/issue resolution in some cases - uploadPath: string - contains temporary upload path to be used for the packet upload

//the response must have a field success set to true and uploadPath.
{
  "success": true
  "syncLogId": "xyz-abc-def-001-002-003...", 
  "uploadPath": "https://s3.xyz.abv.abv.q24....................com"
}

//the developer must execute another PUT request with the packet content to upload the packet.

See also : Synchronization Packet Format

Example - NodeJs

var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://api.portal.dynamicsmobile.com/mobile/erp/push/DMDEV01/user1?packetUniqueId=xyz-abc-01&size=32123&packetType=xml',
  'headers': {
    'x-api-key': '12321313'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
 const xmlResponse = response.body;
 //parse reponse and obtain the value if the uploadPath field.
 //use it to upload the packet content via PUT request
});

Example - C# (RestSharp)

var appArea = "MyAppArea";
var apiKey = "myApiKey";
var userName = "user1"
var packetSize= 12345;
var packetFormat = "xml";
var packetId = DateTime.Now().format(mobileUser+'yyMMddhhmmss'); 
var client = new RestClient("https://api.portal.dynamicsmobile.com/mobile/erp/push/"+appArea +"/"+userName+"?packetUniqueId="+packetId+"&size="+packetSize+"&packetType="+packetFormat);
client.Timeout = -1;
var request = new RestRequest(Method.GET);
request.AddHeader("x-api-key", apiKey);
IRestResponse response = client.Execute(request);
XmlDocument doc = new XmlDocument();
doc.LoadXml(response.Content);
//parse reponse and obtain the value if the uploadPath field.
//use it to upload the packet content via PUT request

Pull Sync Packet

GET https://api.portal.dynamicsmobile.com/erp/pull/:appArea

The API is used by the ERP system to receive a list of inbound pending sync packets received from mobile users. The ERP must download each if the packets and then set the packets status to done.

Path Parameters

Name	Type	Description
appArea	string	The application area code

Query Parameters

Name	Type	Description
packetType	string	defines the type of the packets to be pulled. - packet ( default ) - returns only packets - file - returns only files
format	string	the format (xml or json) in which the response will be returned

Headers

Name	Type	Description
Content-Type	string	Must have value of 'application/json'
x-api-key	string	The API key for the application area.

200

Example - NodeJs

var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://api.portal.dynamicsmobile.com/mobile/erp/pull/DMDEV01?packetType=packet&format=xml',
  'headers': {
    'x-api-key': '12321313'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  const xml = response.body;
  //parse the xml and iterate over the returned list of packets
  
});

Example - C# (RestSharp)

var contentFormat = "xml";
var appArea = "MyAppArea";
var apiKey = "12345678";
var client = new RestClient("https://api.portal.dynamicsmobile.com/mobile/erp/pull/"+appArea+"?format="+contentFormat);
client.Timeout = -1;
var request = new RestRequest(Method.GET);
request.AddHeader("x-api-key", apiKey);
IRestResponse response = client.Execute(request);
XmlDocument doc = new XmlDocument()
doc.LoadXml(response.Content)
//process the list

Get Pull Download Link

GET https://api.portal.dynamicsmobile.com/erp/pull/:appArea/link

The API is used by the ERP system to obtain a temporary sync packet download link. The download must begin in the next 15 minutes ( before the temporary link expires.). This timeout is might change in the future to lower value.

Path Parameters

Name	Type	Description
appArea	string	The application area code

Query Parameters

Name	Type	Description
path	string	the internal cloud storage path of the packet. Can be obtained from the [url] field returned by the Pull Sync Packet API

Headers

Name	Type	Description
Content-Type	string	Must have "application/json" value
x-api-key	string	The api key for the application area

200 returns temporary url, which the ERP must use to download the sync packet content

https://s3.xyz.abv.anx.123.com..........................

Example - NodeJs

const appArea = "MyAppArea";
const apiKey = "123456789"; 
var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://api.portal.dynamicsmobile.com/mobile/erp/pull/'+appArea+'/link?path=push_done/MYAPPAREA/2020010101/user1/xyz-abv-d011.xml',
  'headers': {
    'x-api-key': apiKey
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  const downloadUrl = response.body;
  //execute another get request to the url returned in downloadUrl...
  //the downloaded content is a Synchronization Packet Format
});

Example - C# (RestSharp)

var appArea = "MyAppArea";
var apiKey = "123456789"; 
//packetInternalUrl is actually conained in the url field for each packetin the pending packet list
//recevied via call to the Pull Sync Packet API
//here it is provided as variable to simplify the example
var packetInternalUrl = "push_done/MYAPPAREA/2020010101/user1/xyz-abv-d011.xml";
var client = new RestClient("https://api.portal.dynamicsmobile.com/mobile/erp/pull/"+appArea+"/link?path="+packetInternalUrl );
client.Timeout = -1;
var request = new RestRequest(Method.GET);
request.AddHeader("x-api-key", apiKey);
IRestResponse response = client.Execute(request);
var temporaryDownloadLink  - response.Content;

//execute another get request to the url returned in downloadUrl....

See also : Synchronization Packet Format

Packet Status Done

POST https://api.portal.dynamicsmobile.com/erp/pull/:appArea/done

The API is used by the ERP to mark one or more packets obtained via the Pull api method as completed (done). This will make sure that the packet will not be returned again on the next call to Pull api method

Path Parameters

Name	Type	Description
appArea	string	The application area code

Query Parameters

Name	Type	Description
format	string	format of the body - xml or json

Headers

Name	Type	Description
Content-Type	string	application/json or application/xml
x-api-key	string	The api key for the application area

Request Body

Name	Type	Description
syncpacket list	array	list of objects where each object represent a successfully processed sync packet with the following fields: id: string receiptHandle: string Both of these fields are returned for each packet by call to Pull Sync Packet

200 The response includes the following fields: success: boolean - true if the packet status change was successful message: string - contains the error message incase the success field is false

{
 "success":true
}

Example - NodeJs

const contentFormat = "xml";
const apiKey = "123456";
const packetsToMarkAsCompleted = 
 `<messages>
   <message><id>asdasdasd1</id><receiptHandle>abvabc1</receiptHandle>,
   <message><id>asdasdasd2</id><receiptHandle>abvabc2</receiptHandle>
   <message><id>asdasdasd3</id><receiptHandle>abvabc3</receiptHandle>
  <messages>
 `
   
   ,var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://api.portal.dynamicsmobile.com/mobile/erp/pull/'+appArea+'/done?format='+contentFormat,
  'headers': {
    'x-api-key': apiKey
  }
  'Content-Type': 'application/'+contentFormat
  body: packetsToMarkAsCompleted 
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Example - C#(RestSharp)

var contentFormat = "xml";
var apiKey = "123456";
var packetsToMarkAsCompleted = "<messages>"+
   "<message><id>asdasdasd1</id><receiptHandle>abvabc1</receiptHandle>"+
   "<message><id>asdasdasd2</id><receiptHandle>abvabc2</receiptHandle>"+
   "<message><id>asdasdasd3</id><receiptHandle>abvabc3</receiptHandle>"+
   "<messages>";
 
var client = new RestClient("https://api.portal.dynamicsmobile.com/mobile/erp/pull/"+appArea+"/done?format="+contentFormat);
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("x-api-key",apiKey);
request.AddHeader("Content-Type", "text/plain");
request.AddParameter("application/"+contentFormat, packetsToMarkAsCompleted,  ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);