Mycroft Assistant Integration (API)
Mycroft Assistant is located on the Internet . Its purpose is to offer services that analyze the data of your company’s operations. You provide this information easily and securely.
Successful operation of the service is not complicated. You begin by uploading data to it. This may include, but is not limited to: current product balance, sales and receipts documents of your products, and accompanying guides. It is best to provide a year’s worth of data, and update it on a daily basis. To achieve its goals, Mycroft Assistant system provides an open API based on XML technology. HTTP Secure protocol with bit-stream SSL encryption is used to connect to the system, which assures complete privacy and data integrity.
Customers use the API to download data using their login, and a password and key that are securely delivered. You choose your login email when you register to use the Mycroft system. Your password and login are sent to you, thus completing the registration process. Your password and key can be maintained in your User Profile once you are successfully registered.
Data can be uploaded into the Mycroft Assistant either automatically or manually (see below). You receive results from the system automatically via the exchange connector and can export them manually in.xml, .xls, or .pdf format.
A. Mycroft Assistant integration via the XML API
The customer is provided with the following procedure in order to work with the API:
1. The customer creates two XML files. The first is titled “data.xml” and it contains information on balances, income, and expenditure. The second is “catalog.xml”. Files contains background information including: products transferred (for instance, between warehouses), purchases, sales, etc. This information can be customized.
After these files are created, they need to be packed in “data.zip” archive. The system accepts the data from the files only if they are correctly named. Double-checking the file names will provide optimum results. Samples of the upload files, along with a description, are presented in Section B.
2. Once the files have been properly compiled and named, the customer accesses the server at https://i.mycroft2b.com and establishes a connection. This must pass HTTP Basic Authentication, and will, as long as the correct using login and password are entered as requested.
3. Next, the customer sends a PUT request to the server, using the archive created at step 1. The address for this is: https://i.mycroft2b.com/api/Instances/[KEY]/Import. In the above address, [KEY] is the actual key provided at registration. The customer’s login and password are required at this point.
4. You will know that your data has been successfully loaded by a response of “true.” An unsuccessful load will return a “false”.
5. After the response is received, the connection is broken.
You can manually load the data.zip file created at step 1 into Mycroft Assistant. To do so, you need to:
a) Log in to the system at https://i.mycroft2b.com using your login and password.
b) Open the menu at the right top and select “Preferences.”
c) In the “Data” section, click on the cloud and select the file you created at step 1 (or drag the file using the drug-and-drop approach)..
You can download a sample data.zip file containing catalog.xml and data.xml files, with comments on the fields to fill HERE.
You can download files with XML schemes to control the accuracy of filling catalog.xml and data.xml files HERE.
C. Export. The file that has the data on the order to the supplier is called purchase.xml.
Uploading the orders generated by the system to the supplier is performed manually by the user from the CPS subsystem interface. This is done by clicking the button “Export – XML.” The exported file contains a list of the created orders to the supplier, and is grouped according to product supplier and purchase price
You can download a sample purchase.xml file, complete with comments on the fields HERE.