api_auth

<back to all web services

InfoRequest

The following routes are available for this service:
GET/api/infoInformation about target site, and also about current logged-in user (if any)
InfoRequest Parameters:
NameParameterData TypeRequiredDescription
DomainquerystringYesDomain of a site to return information about
InfoResponse Parameters:
NameParameterData TypeRequiredDescription
SiteformSiteInfoNoSite information
UserformUserInfoNoLogged-in user information
TokenformstringNoOAuth token. Use this token only to connect to Bitpub message bus and receive messages in real-time while on bit.pub web site. Not for use in any other way
TokenTtlformintNoToken expiration time, in seconds.
SiteInfo Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
LanguageformstringNo
DomainformstringNo
InvitationOnlyformboolNo
DatacenterIDformbyteNo
MemberformshortNo
TypeformshortNo
AllowPseudonymformboolNo
UserInfo Parameters:
NameParameterData TypeRequiredDescription
PersonIDformlongNo
NameformstringNo
EmailformstringNo
Telephoneformlong?No
HyperIDformstringNo
IsConfirmedformboolNo
IsEmailConfirmedformboolNo
IsTelephoneConfirmedformboolNo
IsAddressConfirmedformboolNo
IsPassportConfirmedformboolNo
DatacenterIDformbyteNo
SessionIDformlongNo
MailNodeIDformint?No
CanResendConfirmationformboolNo
LanguageformstringNo
ServerTimeformDateTimeNo
ExpirationTimeformDateTimeNoExpiration time of current session
UserAgentformUserAgentInfoNo
SessionKeyformstringNo
MinAuthLevelformintNo
SessionAuthLevelformintNo
UserAgentInfo Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
DeviceNameformstringNo
DeviceTypeformshortNo
OSTypeformshortNo
OSVersionformstringNo
BrowserNameformstringNo
BrowserVersionformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/info HTTP/1.1 
Host: 1.hyper.id 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"site":{"name":"String","language":"String","domain":"String","invitationOnly":false,"datacenterID":0,"member":0,"type":0,"allowPseudonym":false},"user":{"personID":0,"name":"String","email":"String","telephone":0,"hyperID":"String","isConfirmed":false,"isEmailConfirmed":false,"isTelephoneConfirmed":false,"isAddressConfirmed":false,"isPassportConfirmed":false,"datacenterID":0,"sessionID":0,"mailNodeID":0,"canResendConfirmation":false,"language":"String","userAgent":{"name":"String","deviceName":"String","deviceType":0,"osType":0,"osVersion":"String","browserName":"String","browserVersion":"String"},"sessionKey":"String","minAuthLevel":0,"sessionAuthLevel":0},"token":"String","tokenTtl":0}