All of the specific endpoints in our APIs are described in the apis folder.
We have two main kinds of APIs: RPC and REST. We also expose a WFS service using geoserver.
RPC stands for "Remote Procedure Call" and is for "invoking an action on a remote system". Further specific information on our RPC type endpoints is given in this additional file.
- project - SPIDAmin projects and services are defined here. This contains the primary means to interact with SPIDAmin.
- project searches - These methods provide project search capabilities.
- users - Interacting with users and user services are in this service.
- asset - These objects deal with the assets and asset services. An example is an asset is a pole.
- asset search - These methods allow the searching of assets and stations.
- asset creation - These methods allow the creation and modification of assets and stations.
- asset file - These methods allow the interaction with file based assets and stations.
- station linker - These methods allow for the association of related stations between services.
- company - Interacting with company objects. Allows retrieval of Company attributes and details.
- assetmaster
- asset - These objects deal with the assets and asset services. An example is an asset is a pole.
- asset search - These methods allow the searching of assets and stations.
- asset creation - These methods allow the creation and modification of assets and stations.
- filefort
- asset - These objects deal with the assets and asset services. An example is an asset is a pole.
- asset search - These methods allow the searching of assets and stations.
- asset creation - These methods allow the creation and modification of assets and stations.
- asset file - These methods allow the interaction with file based assets and stations.
- projectmanager
- project - SPIDAmin projects and services are defined here. This contains the primary means to interact with SPIDAmin.
- project - These methods provide project search capabilities.
- station linker - These methods allow for the association of related stations between services.
- usersmaster
REST is a specific type of data service, and a few of our more data centric services can be represented this way.
- webhooks - Listen to activity in SPIDAMin from another system
- action - Trigger any of the actions in a work flow with this service.
- spidadb - Push and pull projects into SPIDAdb.
All users must accept the License Agreement. If this has not been accepted, all HTTP requests will be redirected to usersmaster/agreement. Login to SPIDAmin and you will be redirected to the License Agreement. Click the 'Accept' button at the bottom of the page.
For most of the calls against a SPIDAmin service you will need to include your apiToken parameter, this is in addition to any parameters required by the method. This would be for the service interface if it is implemented on a server environment. There are times when we implement the same service in the local environments, and then the apiToken would not be needed, but in most cases it will be required. If you make a service call but get redirect to a security login, then your apiToken was not included or was invalid.
When a call is made to SPIDAmin and the API Token is successfully authenticated a session is created. A new session is created for each different application, a call to AssetMaster and a call to Project Manager will create two sessions. Each session will have to be expired in separate calls, there are two ways to expire a session. Here is an example of expiring an AssetMaster session by calling logout:
curl -g 'https://test.spidasoftware.com/assetmaster/j_spring_security_logout'
The parameter expireSession set to true can also be passed with calls in order to expire the session. An example of this is:
curl -g 'https://test.spidasoftware.com/assetmaster/assetAPI/getStations?station_ids=["1"]&expireSession=true'
The advantage of passing the expireSession parameter is that it does not require another http request just to expire the session.
Once the API Token is successfully authenticated the user will be logged into their home company. The session can be switched to a different company and/or user assuming the user has the correct role. The sessions are per web application so switching in assetmaster will not switch the company in projectmanager. If accessing a project in projectmanager from different company the session should be switched to the company that the project is in. If accessing stations in assetmaster from a different company than users home company the session should be switched to the stations company.
To switch the the assetmaster session:
curl -g 'https://test.spidasoftware.com/assetmaster/switchcompany?coselect=123'
To switch the projectmanager session:
curl -g 'https://test.spidasoftware.com/projectmanager/switchcompany?coselect=123'
Prior to 11-27-2017 coselect value was the company name
To switch the the assetmaster session:
curl -g 'https://test.spidasoftware.com/assetmaster/switchcompany?coselect=TestCompany'
To switch the projectmanager session:
curl -g 'https://test.spidasoftware.com/projectmanager/switchcompany?coselect=TestCompany'
To switch to a different user make a call to:
curl -g 'https://test.spidasoftware.com/assetmaster/switchcompany?userId=1'
You can find this at https://companynamehere.spidastudio.com/spidadb/geoserver/wfs/DB
XML Schema here https://companynamehere.spidastudio.com/spidadb/geoserver/wfs/DB?version=1.0.0&service=wfs&request=DescribeFeatureType
If not logged in, you can use basic authentication. The username is the user's email address. The password is the user's api token.