B-612 API Documentation
Version 1.0

Overview

URL:

Each customer receives an individual webhook URL which we generate using Claris Connect

Methods Supported:

GET
POST
PUT

Description:

  • Generate new Tickets
  • Update existing tickets
  • Retrieve information on open or closed tickets
  • Retrieve billing information per ticket

Authentication:

We employ the Basic Authentication method for making successful calls. Each customer receives an API Key and API ID which are used in the following syntax:

curl --user  apiid:apikey webhook_url

Note: Your API ID is the first six characters of your Webhook URL.

GET Ticket:

  • Use this method to retrieve ONE ticket
  • Responses are in JSON format
  • Required parameter: ID

Example response when retrieving a single ticket:

https://d0v6as.apps.connect.claris.com/api/
webhook/v1/ticket/catch?ID=B-612-R45176

{
   "Method": "GET",
   "location": {
       "address": "Coriander Avenue",
       "city": "London",
       "data_center": "Telehouse Europe",
       "name": "LHR1",
       "postcode": "E14 2AA"
   },
   "b612_details": {
       "b612_engineer": "Amiram Bukowsky",
       "b612_engineer_email": "b612@b-612.co.uk",
       "date_created": "12/14/2020",
       "date_suggested": "12/15/2020",
       "b612_ticket_number": "B-612-R885176",
       "type": "Deployment",
       "status": "Open",
       "time_suggested": "13:00:00"
   },
   "client_details": {
       "owner_email": "jsmith@client.com",
       "owner_name": "John Smith",
       "priority": "Medium",
       "shipment_courier": "UPS",
       "shipment_tracking": "1Z4543DFGER5",
       "ticket_number": "IZAS13233",
       "todo": "Hello B-612 team,   Anthony here from the Customer NOC. Can you perform the following for us?",
       "rack": "R02.D02"
   },
   "hours_log": {
       "total_business_hours": "10",
       "total_non_business_hours": "0",
       "total_expenses": "0"
   }
}



‍

The following elements are returned in the tickets response:

address

Data Center street name and number

city

Data Center city

data_center

Name of the Data Center

name

Client specific name for the DC. e.g. LHR1

postcode

Data Center postcode

b612_engineer

Name of engineer assigned to the ticket

b612_engineer_email

Email of engineer assigned to the ticket

date_created

Ticket creation date

date_suggested

Ticket intervention date as agreed with the customer

b612_ticket_number

B612 generated ticket number

type

Assigned ticket sub category

status

Indicates whether ticket is open or closed

time_suggested

Ticket intervention time as agreed with the customer

owner_email

Email of customer contact person

owner_name

Name of customer contact person

priority

Level of priority as defined by the customer. E.g. Low, Medium, High, Critical

shipment_courier

Name of the courier for tickets where a collection of new delivery is required

shipment_tracking

Shipment tracking number for tickets where a collection of new delivery is required

ticket_number

Customer internal reference number

todo

Detailed information on what we are required to carry out

rack

Rack name/number/location

total_business_hours

Total amount of hours worked within business hours

total_non_business_hours

Total amount of hours worked within non-business hours

total_expenses

Total expenses incurred that are passed on to customer, associated with this ticket

POST Ticket:

  • Use this method to create ONE ticket
  • Responses are in JSON format

Example call when creating a single ticket:

curl --location --request POST 'https://xxxxxx.apps.connect.claris.com/api/
webhook/v1' \
--header 'user: xxxxxx:sdf786asdf6as87df68sdfysdf7a' \
--header 'Content-Type: application/json' \
--data-raw '
{
   "ticket" :
    {
       "client_details" :
        {
           "owner_email" : "John.smith@client.com",
           "owner_name" : "John Smith",
           "priority" : "Medium",
           "shipment_courier" : "UPS",
           "shipment_tracking" : "1Z34234234234",
           "ticket_number" : "ISO12123123122",
           "rack" : "R02.D02",
           "todo" : "Please reboot server"
       },
       "location" :
        {
           "address" : "1780 Business Center Drive",
           "city" : "Ashburn",
           "data_center" : "Anexio VA3",
           "name" : "IAD12",
           "postcode" : "20190"
       }
   }
}'



‍
‍

The following elements are optional in the POST call:

address

Data Center street name and number

city

Data Center city

data_center

Name of the Data Center

name

Client specific name for the DC. e.g. LHR1

postcode

Data Center postcode

owner_email

Email of customer contact person

owner_name

Name of customer contact person

priority

Level of priority as defined by the customer. E.g. Low, Medium, High, Critical

shipment_courier

Name of the courier for tickets where a collection of new delivery is required

shipment_tracking

Shipment tracking number for tickets where a collection of new delivery is required

ticket_number

Customer internal reference number

todo

Detailed information on what we are required to carry out

rack

Rack name/number/location

PUT Ticket:

  • Use this method to update ONE ticket
  • Responses are in JSON format
  • Required data-raw element: b612_ticket_number

Example call when updating a single ticket:

curl --location --request PUT 'https://xxxxxx.apps.connect.claris.com/api/
webhook/v1' \
--header 'user: xxxxxx:sdf786asdf6as87df68sdfysdf7as8df' \
--header 'Content-Type: application/json' \
--data-raw '
{
   "ticket" :
    {
       "b612_details" :
       {
           "ticket_number" : "B-612-R44617"
       },
       "client_details" :
        {
           "owner_email" : "John.smith@client.com",
           "owner_name" : "John Smith",
           "priority" : "Medium",
           "shipment_courier" : "UPS",
           "shipment_tracking" : "1Z34234234234",
           "ticket_number" : "ISO12123123122",
           "rack" : "R02.D02",
           "todo" : "Please reboot server"
       },
       "location" :
        {
           "address" : "1780 Business Center Drive",
           "city" : "Ashburn",
           "data_center" : "Anexio VA3",
           "name" : "IAD12",
           "postcode" : "20190"
       }
   }
}'
‍

The following elements are optional in the PUT call:

address

Data Center street name and number

city

Data Center city

data_center

Name of the Data Center

name

Client specific name for the DC. e.g. LHR1

postcode

Data Center postcode

owner_email

Email of customer contact person

owner_name

Name of customer contact person

priority

Level of priority as defined by the customer. E.g. Low, Medium, High, Critical

shipment_courier

Name of the courier for tickets where a collection of new delivery is required

shipment_tracking

Shipment tracking number for tickets where a collection of new delivery is required

ticket_number

Customer internal reference number

todo

Detailed information on what we are required to carry out

rack

Rack name/number/location
ethernet cable plugnetwork cablenetwork cable