Skip to content

Fibre Cafe : Tenant API (1.17)

Introduction

The Fibre Cafe is a scalable, unified platform to support L2C provisioning, in-life modification/cease and T2R trouble resolution between communication providers (CP) and network operators or aggregators.

CPs are known as 'tenants' on the Fibre Cafe and communicate with this API - the Fibre Cafe's Tenant API. The network operators and aggregators providing the underlying services are known as 'suppliers'.

The Fibre Cafe will route requests from this API to appropriate supplier(s). Tenants will be configured to use suppliers based on requirements and commercial agreements.

Initial availability and appointing requests are synchronous. Ordering requests are asynchronous with confirmation and updates via KCIs (Keep Customer Informed).

Note: Order updates (KCIs) will be sent to the Tenant Updates API which the tenant must implement. __

© 2022-2026 Strategic Imperatives

Download OpenAPI description
Languages
Servers
https://prod.fibregateway.com/v1

Address Lookup

Used to look up address identifiers and details for a given postal code or UPRN.

This is not implemented by all suppliers - it is primarily provided to assist with NAD/District Code lookup for suppliers operating on the Openreach network.

This follows the concepts in TMF673 - Address Management API.

Operations

Service Availability

Retrieve what services (if any) the supplier has available for a given address.

This follows the concepts in TMF645 - Service Qualification API and TMF673 - Address Management API.

Operations

Quote Management

Create and manage a quote to provide service at requested sites. This follows the concepts in TMF648 - Quote Management API.

Operations

Appointment Management

Retrieve and reserve appointments for installing or maintaining a service at a given address.

This follows the concepts in TMF646 - Appointment API.

Operations

Order Management

Create and manage an order to provide, cease or modify a service at a given address.

This follows the concepts in TMF641 - Service Ordering Management API.

Operations

Service Test Management

Operations

Create a service test record for an active service.

Request

This endpoint can be called to perform a service test on an active service.

The Fibre Cafe will validate the request and generate a service test identifier which is returned. If the test request is rejected immediately then a 4XX code will be returned with reason(s) for the rejection in the response.

The Fibre Cafe will internally determine the best supplier test to execute based on supplier and service specification attributes, in addition to the PROBLEM_TYPE characteristics supplied.

The service test result will be returned asynchronously via a KCI, and may also be queried via the GET /service-tests/{id} API.

Security
oauth2
Headers
X-Request-IDstringrequired

Unique identifier to identify request and response events across the Fibre Cafe gateway

X-Conversation-IDstringrequired

Identifier to track message journey across the Fibre Cafe gateway

Bodyapplication/json
serviceIdstring[ 1 .. 50 ] charactersrequired

Identifier of an existing live service

Example: "SI2345432345345"
problemTypestring^[\w_]{3,15}required

The type of problem being experienced with the service.

  • CPE
  • CUSTOMER
  • OUTAGE
  • PERFORMANCE
  • STABILITY
  • SYNCHRONISATION
serviceSpecificationobject(ServiceSpecification)required

Details of a service the supplier provides at the selected address.

serviceSpecification.​idstring[ 1 .. 50 ] charactersrequired

Unique identifier for this service specification

Example: "ftthl2r"
supplierstring^[\w_]{1,20}required

System identifier for a supplier on the Fibre Cafe that is associated with this service

Example: "DUMMY_SUPPLIER"
characteristicsArray of objects(ServiceTestCharacteristic)non-emptyrequired
characteristics[].​namestring[ 1 .. 50 ] charactersrequired

Name of the characteristic

characteristics[].​valuestring[ 1 .. 50 ] charactersrequired

Value for this characteristic

curl -i -X POST \
  https://prod.fibregateway.com/v1/service-tests \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-Conversation-ID: string' \
  -H 'X-Request-ID: string' \
  -d '{
    "serviceId": "SI2345432345345",
    "problemType": "string",
    "serviceSpecification": {
      "id": "ftthl2r"
    },
    "supplier": "DUMMY_SUPPLIER",
    "characteristics": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  }'

Responses

Request was received by the Fibre Cafe and will be acknowledged later via a KCI

Headers
X-Request-IDstringrequired

Unique identifier to identify request and response events across the Fibre Cafe gateway

X-Conversation-IDstringrequired

Identifier to track message journey across the Fibre Cafe gateway

Bodyapplication/json
idnumber>= 1read-onlyrequired

Unique reference identifying this service test (test number - generated by Fibre Cafe)

Example: 123
statusstring(ServiceTestStatus)required

Service test lifecycle adapted from TMF653 - update events (KCIs) will be sent to the tenant as the test transitions from one state to the other.

Enum"RECEIVED_BY_GATEWAY""SENT_TO_SUPPLIER""FAILED_TO_SEND""REJECTED""IN_PROGRESS""FAILED""COMPLETED"
Example: "IN_PROGRESS"
createdstring(date-time)read-only

Date/time when the service test was created

Example: "2022-01-01T09:09:33.001Z"
updatedstring(date-time)read-only

Date/time when the service test was last updated

Example: "2022-01-01T09:45:39.001Z"
supplierReferencestring[ 1 .. 50 ] charactersread-only

Supplier reference for this service test (if available - for information only)

Example: "A12345"
serviceIdstring[ 1 .. 50 ] charactersrequired

Identifier of an existing live service

Example: "SI2345432345345"
problemTypestring^[\w_]{3,15}required

The type of problem being experienced with the service.

  • CPE
  • CUSTOMER
  • OUTAGE
  • PERFORMANCE
  • STABILITY
  • SYNCHRONISATION
serviceSpecificationobject(ServiceSpecification)required

Details of a service the supplier provides at the selected address.

serviceSpecification.​idstring[ 1 .. 50 ] charactersrequired

Unique identifier for this service specification

Example: "ftthl2r"
serviceSpecification.​namestring[ 1 .. 50 ] charactersread-only

Name of the service

Example: "FTTH"
supplierstring^[\w_]{1,20}required

System identifier for a supplier on the Fibre Cafe that is associated with this service

Example: "DUMMY_SUPPLIER"
characteristicsArray of objects(ServiceTestCharacteristic)non-emptyrequired
characteristics[].​namestring[ 1 .. 50 ] charactersrequired

Name of the characteristic

characteristics[].​valuestring[ 1 .. 50 ] charactersrequired

Value for this characteristic

Response
application/json
{ "id": 123, "status": "IN_PROGRESS", "created": "2022-01-01T09:09:33.001Z", "updated": "2022-01-01T09:45:39.001Z", "supplierReference": "A12345", "serviceId": "SI2345432345345", "problemType": "string", "serviceSpecification": { "id": "ftthl2r", "name": "FTTH" }, "supplier": "DUMMY_SUPPLIER", "characteristics": [ {} ] }

Retrieve current service test details including result if available.

Request

This endpoint is called to retrieve the current details and status for a service test request. The result of the test will be returned if available.

Security
oauth2
Path
idstringrequired

Find service test details relating to the specified identifier

Headers
X-Request-IDstringrequired

Unique identifier to identify request and response events across the Fibre Cafe gateway

X-Conversation-IDstringrequired

Identifier to track message journey across the Fibre Cafe gateway

curl -i -X GET \
  'https://prod.fibregateway.com/v1/service-tests/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-Conversation-ID: string' \
  -H 'X-Request-ID: string'

Responses

Request successful - service test details were returned

Headers
X-Request-IDstringrequired

Unique identifier to identify request and response events across the Fibre Cafe gateway

X-Conversation-IDstringrequired

Identifier to track message journey across the Fibre Cafe gateway

Bodyapplication/json
idnumber>= 1read-onlyrequired

Unique reference identifying this service test (test number - generated by Fibre Cafe)

Example: 123
statusstring(ServiceTestStatus)required

Service test lifecycle adapted from TMF653 - update events (KCIs) will be sent to the tenant as the test transitions from one state to the other.

Enum"RECEIVED_BY_GATEWAY""SENT_TO_SUPPLIER""FAILED_TO_SEND""REJECTED""IN_PROGRESS""FAILED""COMPLETED"
Example: "IN_PROGRESS"
createdstring(date-time)read-only

Date/time when the service test was created

Example: "2022-01-01T09:09:33.001Z"
updatedstring(date-time)read-only

Date/time when the service test was last updated

Example: "2022-01-01T09:45:39.001Z"
supplierReferencestring[ 1 .. 50 ] charactersread-only

Supplier reference for this service test (if available - for information only)

Example: "A12345"
serviceIdstring[ 1 .. 50 ] charactersrequired

Identifier of an existing live service

Example: "SI2345432345345"
problemTypestring^[\w_]{3,15}required

The type of problem being experienced with the service.

  • CPE
  • CUSTOMER
  • OUTAGE
  • PERFORMANCE
  • STABILITY
  • SYNCHRONISATION
serviceSpecificationobject(ServiceSpecification)required

Details of a service the supplier provides at the selected address.

serviceSpecification.​idstring[ 1 .. 50 ] charactersrequired

Unique identifier for this service specification

Example: "ftthl2r"
serviceSpecification.​namestring[ 1 .. 50 ] charactersread-only

Name of the service

Example: "FTTH"
supplierstring^[\w_]{1,20}required

System identifier for a supplier on the Fibre Cafe that is associated with this service

Example: "DUMMY_SUPPLIER"
characteristicsArray of objects(ServiceTestCharacteristic)non-emptyrequired
characteristics[].​namestring[ 1 .. 50 ] charactersrequired

Name of the characteristic

characteristics[].​valuestring[ 1 .. 50 ] charactersrequired

Value for this characteristic

resultobject(ServiceTestResult)

Result of a service test request once available.

Response
application/json
{ "id": 123, "status": "IN_PROGRESS", "created": "2022-01-01T09:09:33.001Z", "updated": "2022-01-01T09:45:39.001Z", "supplierReference": "A12345", "serviceId": "SI2345432345345", "problemType": "string", "serviceSpecification": { "id": "ftthl2r", "name": "FTTH" }, "supplier": "DUMMY_SUPPLIER", "characteristics": [ {} ], "result": { "testValidity": "2022-01-01T09:45:39.001Z", "testMeasures": [], "testOutcome": {} } }

Service Problem Management

Operations