Getting Started
The DropTime API enables functionality and interactivity with your own software applications. To get started, all you need is an active DropTime account. You can then start making HTTP calls using the provided definitions.
Supported Formats
The DropTime API supports the input and output of JSON. All input (if required) accepts a JSON array unless otherwise noted.
Obtaining access and authorization
To obtain a session API key and password, access the 'StartAPISession' Method by appending 'Method=StartAPISession' to the base URL (https://api.droptime.net/API.aspx?). followed by your CompanyID, UserName and Password separated by a '&' in the API query string.
Supported Methods
DropTime simplifies and streamlines all API calls into a POST method.
Request Input/Output
To either POST or retrieve data in your desired format, append "&input=" and "&output=" respectively along with your desired language (JSON or XML). If not specified, the request will default to JSON.
Restrictions
For the safety and integrity of all DropTime user information, we disallow input that contains: a single quote ('), a semicolon(;), a forward slash with an asterisk appended (/*), an asterisk with a forward slash appended (*/), and two simultaneous dashes (--).
Example Query:
https://api.droptime.net/API.aspx?Method=StartAPISession&CompanyID=12345&UserName=12345&Passcode=123456&Manager=M
Example JSON Response:
{
"SessionError": "0",
"Session Information": {
"SessionID": "123",
"SessionPassword": "12345678"
}
}
Use the given SessionID and SessionPW in the query field during each HTTP API call
URL Format
Base API Call URL
All API calls begin with the base URL.
https://api.droptime.net/API.aspx?
Authentication
Use a '&' after the base URL to designate each section. Input your given SessionID and password here using 'SessionID= ' and 'SP= ' remembering to separate each by a '&'.
https://api.droptime.net/API.aspx?SessionID=123&SP=12345678
API Method Call
Append the API method call after authentication
https://api.droptime.net/API.aspx?SessionID=123&SP=12345678&Method=getPOSData
Method Parameters
If the API method requires query parameters, append them after the method call separating the parameters by a '&'
https://api.droptime.net/API.aspx?SessionID=123&SP=12345678&Method=getPOSData&StartDate=01-01-2000&EndDate=01-01-2001
Definitions
Miscellaneous | ||
---|---|---|
getPOSData | Retrieve point of sale data | POST |
importViewpointItems | Import Line Items into the system | POST |
getDispatchInfo | Retrieves specified dispatches | POST |