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 .xml suffix or ?format=xml

HTTP + XML

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/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<InfoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bitpub.Api.Auth.Common">
  <Site>
    <AllowPseudonym>false</AllowPseudonym>
    <DatacenterID>0</DatacenterID>
    <Domain>String</Domain>
    <InvitationOnly>false</InvitationOnly>
    <Language>String</Language>
    <Member>0</Member>
    <Name>String</Name>
    <Type>0</Type>
  </Site>
  <Token>String</Token>
  <TokenTtl>0</TokenTtl>
  <User>
    <CanResendConfirmation>false</CanResendConfirmation>
    <DatacenterID>0</DatacenterID>
    <Email>String</Email>
    <ExpirationTime>0001-01-01T00:00:00</ExpirationTime>
    <HyperID>String</HyperID>
    <IsAddressConfirmed>false</IsAddressConfirmed>
    <IsEmailConfirmed>false</IsEmailConfirmed>
    <IsPassportConfirmed>false</IsPassportConfirmed>
    <IsTelephoneConfirmed>false</IsTelephoneConfirmed>
    <Language>String</Language>
    <MailNodeID>0</MailNodeID>
    <MinAuthLevel>0</MinAuthLevel>
    <Name>String</Name>
    <PersonID>0</PersonID>
    <ServerTime>0001-01-01T00:00:00</ServerTime>
    <SessionAuthLevel>0</SessionAuthLevel>
    <SessionID>0</SessionID>
    <SessionKey>String</SessionKey>
    <Telephone>0</Telephone>
    <UserAgent>
      <BrowserName>String</BrowserName>
      <BrowserVersion>String</BrowserVersion>
      <DeviceName>String</DeviceName>
      <DeviceType>0</DeviceType>
      <Name>String</Name>
      <OSType>0</OSType>
      <OSVersion>String</OSVersion>
    </UserAgent>
  </User>
</InfoResponse>