Client library for Sessions API

npm install --save @datafire/whapi_sessions

let whapi_sessions = require('@datafire/whapi_sessions').create();

.then(data => {
  console.log(data);
});

The William Hill Sessions API uses a central authentication service (CAS*) on all resources that require access to a customer’s account or betting functionality. To authenticate, you’ll need to supply a sportsbook username and password, in return you will be given an authentication ticket, which you can use on the majority of requests found within our services.


The Sessions API should be used whenever you want to login a customer and:

• continue to use the William Hill API for that customer’s transactions
• use other CAS-enabled William Hill services outside the suite of APIs

Logs in a customer by obtaining an authentication ticket. It can then be used directly with the other William Hill APIs to access a customer’s sportsbook account, place a bet, etc.

whapi_sessions.logIn({
  "apiKey": "",
  "apiSecret": "",
  "login": {
    "username": "",
    "password": ""
  }
}, context)

• input object
  • apiKey required string: A unique identifier of your application that is generated by the API portal.
  • apiSecret required string: Another unique identifier for your application.
  • fields array: Specify an absolute field list to return (Comma Separated List)
  • include array: Specify fields in addition to the default to return (Comma Separated List)
  • exclude array: Specify fields from the default to exclude (Comma Separated List)
  • territory string: Territory from which request originates
  • languageAsPerTerritory string: Defines response field name language, true (default) returns in language defined by territory, false returns in English
  • login required loginRequest

• output session

Logs out a customer.

whapi_sessions.logOut({
  "apiKey": "",
  "apiSecret": "",
  "tgt": ""
}, context)

• input object
  • apiKey required string: A unique identifier of your application that is generated by the API portal.
  • apiSecret required string: Another unique identifier for your application.
  • tgt required string: Ticket Granting Ticket obtained from a previous request
  • territory string: Territory from which request originates
  • languageAsPerTerritory string: Defines response field name language, true (default) returns in language defined by territory, false returns in English

• output logoutresponse

Checks the validity of a session ticket.

whapi_sessions.validateSession({
  "apiKey": "",
  "apiSecret": "",
  "tgt": ""
}, context)

• input object
  • apiKey required string: A unique identifier of your application that is generated by the API portal.
  • apiSecret required string: Another unique identifier for your application.
  • tgt required string: Ticket Granting Ticket obtained from a previous request
  • territory string: Territory from which request originates
  • languageAsPerTerritory string: Defines response field name language, true (default) returns in language defined by territory, false returns in English

• output ticketvalidityresponse

Obtains a one-time Service Ticket that can be used to access other CAS enabled William Hill services that are not available through the standard suite of APIs. You first need to have logged in a customer to obtain an Authentication Ticket.

whapi_sessions.getServiceTicket({
  "apiKey": "",
  "apiSecret": "",
  "tgt": "",
  "target": ""
}, context)

• input object
  • apiKey required string: A unique identifier of your application that is generated by the API portal.
  • apiSecret required string: Another unique identifier for your application.
  • tgt required string: Ticket Granting Ticket obtained from a previous request
  • territory string: Territory from which request originates
  • languageAsPerTerritory string: Defines response field name language, true (default) returns in language defined by territory, false returns in English
  • target required string: The target URL of the CAS enabled service that you want to use with the service ticket.
  • fields array: Specify an absolute field list to return (Comma Separated List)
  • include array: Specify fields in addition to the default to return (Comma Separated List)
  • exclude array: Specify fields from the default to exclude (Comma Separated List)

• output serviceTicket

• error object
  • code string: A unique William Hill identifier for the error
  • field string: To help pinpoint the exact parameter where a request has failed
  • message string: A unique William Hill text string to enable you to identify the error

• loginRequest object
  • extended boolean: Whether extended login or normal login is required. If the parameter is set to Y your application will generate an authentication ticket valid for a period of 60 days, without expiring due to inactivity. If the parameter is left blank or set to N this means your application will support the normal expiry times for tickets: The ticket expires after 2 hours of inactivity. The ticket is valid for a maximum of 8 hours after it has been issued.
  • password required string: Customer Password
  • username required string: Customer Username

• logoutresponse object
  • success boolean

• serviceTicket object
  • location string: This is the URL of the target service sent in the request. This is a combination of the endpoint and the ticket for future operations such as DELETE.
  • ticket required string: The TGT ticket

• session object
  • expiryDateTime required string: The UTC time when the ticket expires.
  • extended boolean: The value you have selected previous to executing the request. If the value is Y, this enables your application to generate a ticket valid for 60 days without expiring due to inactivity.
  • location string: This is the URL of the target service sent in the request. This is a combination of the endpoint and the ticket for future operations such as DELETE.
  • temporaryPassword boolean: Indicates that the account has a temporary password set and hence the user must be prompted to change their password.
  • temporaryPasswordUrl string: Url for user to change password. A TGT must be added to the URL
  • ticket required string: The TGT ticket

• sessionsErrors object
  • errors array
    • items error

• ticketvalidityresponse object
  • valid boolean