Web service - Applications
Webservice Standard
Documentation of available methods and API capabilities can be found in the following article: Developer documentation → API → Webservice standard
Credentials
Access to the Webservice Standard service requires creating an application with a username and password, necessary to communicate with the API.
The username and password must be placed in the header of the basic authentication (Authorization: Basic) for the entire API communication.
POST /webservice/WebservicePremium/Users/Login HTTP/1.1
Authorization: Basic cGFydG5lcjpwYXJ0bmVy
Header generation example - Authorization: Basic
base64_encode($name . ':' . $password)
The next security measure required for the API to work is placing the API key in the X-API-KEY header for the entire API communication.
POST /webservice/WebservicePremium/Users/Login HTTP/1.1
X-API-KEY: VMUwRByXHSq1bLW485ikfvcC97P6gJs2
Authorization: Basic cGFydG5lcjpwYXJ0bmVy
The key is generated after the application is created, and it can be copied to the clipboard by clicking the button.
Authentication
The keys are unique for each application that connects to the YetiForce system. In order to be able to download and send data, you need to specify the level of permissions for the API. For this purpose, the Users/Login method was created, which allows authorization and creation of a session. This allows you to call methods that require a certain level of permissions to perform operations.
A description of credential management can be found here: Administrator documentation → Integration → Web service - Users.
The authorization token should be placed in the X-TOKEN header for the entire API communication.
POST /webservice/WebservicePremium/Users/Login HTTP/1.1
X-TOKEN: 64e56d9eaff876342e61055e338e10dc844634de5aaea6901b7c005c7c5fc6d0
X-API-KEY: VMUwRByXHSq1bLW485ikfvcC97P6gJs2
Authorization: Basic cGFydG5lcjpwYXJ0bmVy
YetiForce RestApi SDK
Basic SDK has been created for communication with YetiForce RestAPI, the code can be found in our GitHub repository: https://github.com/YetiForceCompany/YetiForceScripts/tree/master/YetiREST
An example script showing how to call key API methods:
loading...