The handshake function provides authentication with FAP Services. The method returns a "token" that must be used to call the API. Every token expires after two hours of being created.

NOTE: The handshake expires after two hours, so you need to renew it after that period.



Input Parameters

name type comment
login string FAP account login
password string FAP account password
apikey string Developer's Key

When you code an application for FAP Services you must include your Developer Key with it, but NOT login and password, they must be provided by users of your application. The authentication token returned by this method is required as a parameter by all other methods in the API.


The method return a String containing the handshake. The handshake is valid for 2 hours. You can request as many handshakes as you want at same time.


<?xml version="1.0" encoding="utf-8"?>
<ServiceResultOfString xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

In case of an error, the Result is returned empty (null) and the field Error is populated with the error message.


Returns ServiceResult<string>

Unless otherwise stated, the content of this page is licensed under Creative Commons Attribution-ShareAlike 3.0 License