ePortal has a web service structure that can be called from an external application. This web service, called eBridgeServices, allows external applications to retrieve documents or submit them for processing on ePortal all through HTTPS.
How to get started
Set up an Account
To use our Development Kit, you must be a Member of eBridge Connections. For membership information, please contact us.
Development Kit
eBridgeServices has many methods, however for exchanging documents with ePortal there are three main methods. These methods are SendFile, GetDocumentList and GetDocument. These eBridge Services methods are not specific to any transaction type, so any document can be sent or received through these methods.
eBridge Web Services API Method List
For a complete list of services, please refer to our ePortal Services List.
SendFile
Purpose
- This method is used to submit data for processing by ePortal.
Input parameters
- Login (string) The ePortal userID.
- Password (string) The ePortal password for that user.
- Content (string) This is the document to be uploaded.
- Filename (string) This is the name of the file with no path information.
Return Value
- SendFileResult (boolean) The boolean return value represents success or failure of the submission of a document.
Get Document
Purpose
- This method is used to retrieve a specific document. It requires the unique document ID which can be obtained by using the GetDocumentList2 method.
Input parameters
- Login (string) The ePortal userID.
- Password (string) The ePortal password for that user.
- sys_no (int) The unique ID of the document desired.
Return Value
- GetDocumentResult(string) The return value from this method is the content of the document requested.
GetDocumentList
Purpose
- This method returns an array of document IDs based on the filter criteria specified. This method supports DateTime data types for the dates. If you cannot support a DateTime data type, please use the GetDocumentList2 method.
Input parameters
- Login (string) The ePortal userID.
- Password (string) The ePortal password for that user.
- Status (string) Possible values here are All or New.
- DocType (string) This is the type of the document such as ORDERS or 850.
- Partner (string) This is the name of the partner
- FromDate (string) This is earliest document transaction date that will be returned, This filter can include time.
- ToDate (string) This is latest document transaction date that will be returned, This filter can include time.
Return Value
- GetDocumentList2Result (string) This function returns an XML data set containing a collection of document IDs which are integers.
GetDocumentList2
Purpose
- This method returns an array of document IDs based on the filter criteria specified. This method accepts strings for the date parameters. If you wish to use the DateTime data type, please use the GetDocumentList method.
Input parameters
- Login (string) The ePortal userID.
- Password (string) The ePortal password for that user.
- Status (string) Possible values here are All or New.
- DocType (string) This is the type of the document such as ORDERS or 850.
- Partner (string) This is the name of the partner
- FromDate (string) This is earliest document transaction date that will be returned, This filter can include time.
- ToDate (string) This is latest document transaction date that will be returned, This filter can include time.
Return Value
- GetDocumentList2Result (string) This function returns an XML data set containing a collection of document IDs which are integers.