Last Updated: October 22, 2023

Responsible Individual: Ben Saunders

<aside> 💡 Purpose: This document describes the API details for connecting to Signapse BSL Train Announcements.

Covered:

• Authentication
• Generate train announcement request
• Types of announcements available </aside>

Introduction

This API documentation explains how to generate BSL train announcement videos using Signapse AI technology.

Example announcements can be seen at the bottom and below, with generated videos here:

• The 14.22 train to Saltburn will depart from platform 1
• The train to Weymouth via Southampton Central and Bournemouth
• The 11:30 train to London Kings Cross will now depart at 16:30 from Platform 6
• The 18.45 train to London King’s Cross has been cancelled. This disruption is due to a passenger being taken ill.

Authentication

Authentication is based on oauth2 specification and all the API endpoints are behind this authentication. So its necessary to authenticate with our servers first in order to gain access to the resources.

curl --location --request POST '<https://sign-stag.auth.eu-west-2.amazoncognito.com/>
oauth2/token' \\
--header 'Content-Type: application/x-www-form-urlencoded' \\
--header 'Authorization: Basic {clientid&clientSecretBase64}' \\
--data-urlencode 'grant_type=client_credentials'

We will provide the clientid and clientsecret to generate the Basic value in the Authorization header.

This endpoint will return the below response with 200 status code. Access token here is a JWT token.

{
    "access_token": "jwttoken",
    "expires_in": 3600,
    "token_type": "Bearer"
}

Generate BSL Train Announcement Vide

Use this API endpoint to make a BSL Train Announcement request.

curl --location '<https://sign.client.api.stag.signapsesolutions.com>
/v1/sign-requests/train-announcements' \\

--header 'Authorization: Bearer {token}' \\
--header 'Content-Type: application/json' \\
--data '{
    "destination": "HOB",
    "timing": "1210",
    "platform": "1", 
    "operator": "SE"
}'

This endpoint will return the below response with 200 status code.