This article is valid for SmartView API ver. 5.3 and later
- Have requests installed (To install requests you can enter the following to your command line interface after python and pip are set up:
- “Python -m install requests”
- Have access to a SmartView Domain
- Acquire an API Access (Name & Key)
- For more information, please refer to the Documentation
- Enter your API Access to the configurations file as well as the Domain and the web address and save the information
- Possible web addresses are:
- https://api-sandbox.antaris-solutions.net Sandbox/Playground Server
- https://api-test.antaris-solutions.net Testing
- https://api-staging.antaris-solutions.net Staging
- https://apisv.antaris-solutions.net Production Server
Executing a Use case
- Open The command line interface (Console) by entering “CMD” to the start menu
- Navigate to the folder where the use cases are saved with use of the “cd” command (for example if your files are located in a folder on the desktop “CD Desktop/folder”
- Enter “python use_case_x.py”(replace x with the use case you wish to execute)
- Follow the steps displayed in the command line window
Use cases
|
Name |
Function |
|
Use_case_1.py |
Create a new Location with a variable number of sectors. |
|
Use_case_2.py |
Assign an Event profile to a sector |
|
Use_case_3.py |
Assign a device to a sector (Uses the current time/date as start) |
|
Use_case_4.py |
Create A shipment |
|
Use_case_5.py |
Get measurements for a sector |
Supporting files
|
Name |
Function |
|
Configuration |
Stores the Log-in credentials |
|
Log_in.py |
Log’s in to the Smartview systems and returns the Token of the current session |