Contact Centre Web Services

1. Introduction

The documentation for the Contact Centre Web Services (web service) can be found on relevant pages on developer.puzzel.com.

1.1. Customer Area and API base address

Depending on which area a customer belongs to, the API base address will be different. The API base address is the common part of the API endpoint that remains consistent across all API calls.

Currently the following areas are defined:

- Global

Authentication Web Service:

• API: auth.puzzel.com aka $(authBaseAddress)
• Swagger: https://auth.puzzel.com/swagger

Contact Centre Web Services: api.puzzel.com/contactcentre5 aka $(apiBaseAddress)

- UK

Authentication Web Service:

• API: ukauth.puzzel.com aka $(authBaseAddress)
• Swagger: https://ukauth.puzzel.com/swagger

Contact Centre Web Services: uk.puzzel.com/api/contactcentre5 aka $(apiBaseAddress)

---

2. Authentication

All endpoints for the web service requires a valid access token.

2.1 Auth: Web Request and Web Response

The token is generated by the Authentication Web Service (see above for Swagger link).

Below is a simplified example on how to use the Authentication Web Service.

The Auth web request requires a valid customer key, a user account and the account password.

POST https://$(authBaseAddress)/api/authenticate/login
Content-Type: application/json
{
  "CustomerKey":"{your customer key}",
  "UserName":"{your user account}",
  "Password":"{user account password}"
}

The Auth web response contains the access token, if the HTTP Status Code is 200.

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "accessToken": "eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9 - - -",
  . . . 
}

2.2 Web Service: Usage of access token

All further web request towards the web service must contain the Authorization: Bearer {accessToken} field, like this:

GET https://$(apiBaseAddress)/accesstokeninformation
Authorization: Bearer eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9 - - -