SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /FACORPAPI/FAWAPI.asmx HTTP/1.1
Host: dev.filesanywhere.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.filesanywhere.com/SAMLAccountLogin"
string
string
string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
string
string
string
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /FACORPAPI/FAWAPI.asmx HTTP/1.1
Host: dev.filesanywhere.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
string
string
string
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
string
string
string
Sample Visual Basic.Net Code
Private Sub SAMLAccountLogin()
Dim FAWAPI As New WebReference.FAWAPI
Dim LoginResult As New WebReference.LoginResult
LoginResult = FAWAPI.SAMLAccountLogin(APIKey, EmailAddress, SAML20SecurityToken)
If LoginResult.ErrorMessage <> "" Then
Msgbox LoginResult.ErrorMessage
Else
Dim Token As String = LoginResult.Token
End If
LoginResult = Nothing
FAWAPI = Nothing
End Sub
Request Arguments
Name
|
Data Type
|
Required
|
Description
|
APIKey
|
String
|
Yes
|
A Developer API Key. The “Getting Started” section describes how to obtain a Developer API Key
|
EmailAddress
|
String
|
Yes
|
Email address used for Single Sign-On integration and configured into identity provider settings for user.
|
SAMLToken
|
String
|
Yes
|
SAML security token received from identity provider after authentication.
|
Response
LoginResult
LoginResult Properties
Name
|
Data Type
|
Description
|
ErrorMessage
|
String
|
A description of the error, if any encountered while the SAMLAccountLogin method was executed. If the SAMLAccountLogin call was successful, the ErrorMessage is blank.
|
Token
|
String
|
A Token ID to be used in subsequent API calls
|
ClientEncryptedPassword
|
String
|
This will be always blank and not applicable for Single Sign-On authentication.
|
GoogleOAuthAccountLogin
This method logs you in to your FilesAnywhere account using GoogleOAuth security code and starts an API session. It returns back a Token ID which must be used for subsequent API calls.
Syntax
LoginResult = GoogleOAuthAccountLogin(APIkey, EmailAddress, OAuthCode, ApplicationType)
Usage
Use the GoogleOAuthAccountLogin call to login to your FilesAnywhere account using GoogleOAuth code and start a client API session. A client application must first login and obtain a Token ID before making other API calls.
The following parameters are needed to make the GoogleOAuthAccountLogin call:
-
APIKey (A Developer API Key. See the “Getting Started” section above, to find out how to obtain a Developer API Key).
-
EmailAddress (Email address used for Single Sign-On integration). This is the email address configured in Google account for user’s identity.
-
OAuthCode. This is the Google autheorization code received from Google for FilesAnywhere application after authentication.
-
ApplicationType. Based on the calling application type parameter value needs to pass. Possible values are as below:
-
Native Applications: 1
-
Native application covers all installed applications like Windows app, Androied app, iOS app etc.
-
FilesAnywhere Mobile Web app: 2
Share with your friends: |