Bureaucrats, editor, Administrators
470
edits
Changes
Jump to navigation
Jump to search
Created page with "{{Api_Method_Spec| Description=This method can be used to get a valid anonymous '''token''' from GVP Platform. The token is used in almost all requests in UNIAPI to identify the ..."
{{Api_Method_Spec|
Description=This method can be used to get a valid anonymous '''token''' from GVP Platform. The token is used in almost all requests in UNIAPI to identify the user. In the case of this method, the user will be Anonymous. The token generated is valid during the next 24 hours (configurable in GVP).
The anonymous token can be easily identified because it starts with the chars: <span style="color: #a11;">AN_</span>
==== Geo-Location ====
This method doesn't apply any GeoLocation, as Anonymous login is allowed from any country.
==== BI ====
This method creates an entry in GVP_LogLogin collection.
|Parameters=
{{Api_Parameter|
ParamName=deviceType
|ParamType=int
|ParamRequired=required
|ParamDescription=The device type code (see #DeviceTypeCodes enumeration to know the list of device types allowed)
}}
{{Api_Parameter|
ParamName=instanceId
|ParamType=int
|ParamRequired=required
|ParamDescription=The id of the instance (OB) for the current environment. This ID might vary depending on the environment.
}}
|Returns=
Returns a JSON object containing the generated anonymous token and its expiration time (in UnixTimestamp format).
'''Example:'''
{
: [[Login]] object
}
|Exceptions=
None
|Cache=
This method is not cached.
|KnownIssues=
None
|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author
{{!}}- valign="top"
! 1.0
{{!}} Initial method design
{{!}} Harley Cabral
{{!}}}
|SeeAlso=
}}
Description=This method can be used to get a valid anonymous '''token''' from GVP Platform. The token is used in almost all requests in UNIAPI to identify the user. In the case of this method, the user will be Anonymous. The token generated is valid during the next 24 hours (configurable in GVP).
The anonymous token can be easily identified because it starts with the chars: <span style="color: #a11;">AN_</span>
==== Geo-Location ====
This method doesn't apply any GeoLocation, as Anonymous login is allowed from any country.
==== BI ====
This method creates an entry in GVP_LogLogin collection.
|Parameters=
{{Api_Parameter|
ParamName=deviceType
|ParamType=int
|ParamRequired=required
|ParamDescription=The device type code (see #DeviceTypeCodes enumeration to know the list of device types allowed)
}}
{{Api_Parameter|
ParamName=instanceId
|ParamType=int
|ParamRequired=required
|ParamDescription=The id of the instance (OB) for the current environment. This ID might vary depending on the environment.
}}
|Returns=
Returns a JSON object containing the generated anonymous token and its expiration time (in UnixTimestamp format).
'''Example:'''
{
: [[Login]] object
}
|Exceptions=
None
|Cache=
This method is not cached.
|KnownIssues=
None
|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author
{{!}}- valign="top"
! 1.0
{{!}} Initial method design
{{!}} Harley Cabral
{{!}}}
|SeeAlso=
}}
