Skip to content

Fibre Cafe : Supplier API (1.15)

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 the Fibre Cafe's Tenant API. The network operators and aggregators providing the underlying services are known as 'suppliers' and provide the Supplier API.

Each supplier is responsible for implementing this southbound API specification for the Fibre Cafe to retrieve available services and support appointing and order management.

Note: Order updates (KCIs) must be sent to the Supplier Updates API hosted by the Fibre Cafe. __

© 2022-2026 Strategic Imperatives

Download OpenAPI description
index.json
index.yaml
Languages
Servers
https://api.provided_by_supplier.net

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 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

Handle a request to perform a service test on a given active line/service.

Operations

Perform a service test on an active live/service.

Request

This endpoint is called to request a service test on an active line/service.

The supplier should validate and accept the request if the validation is successful or otherwise reject it. If the service test is rejected, a 422 code should be returned with reason(s) for the rejection in the response.

If the service test is accepted, the supplier should return a 201 created response with the service test reference and start the test. The result of the service test should be sent asynchronously via the Fibre Cafe - Supplier Updates API once the test has completed.

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

Tenantstringrequired

The tenant that has placed the request on the Fibre Cafe

Example: TENANT1
Bodyapplication/json
idnumber>= 1required

Unique identifier for this service test request (generated by the Fibre Cafe)

Example: 23467
serviceIdstring[ 1 .. 50 ] charactersrequired

Identifier of an existing live service

Example: "SI2345432345"
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 (if available)

Example: "ftthl2r"
problemTypestring(ServiceProblemType)^[A-Z_]{5,25}required

Codes representing the type of problem being encountered by the end user:

  • OUTAGE
  • PERFORMANCE
  • STABILITY
  • SYNCHRONISATION
  • CUSTOMER
  • CPE
Example: "STABILITY"
curl -i -X POST \
  https://api.provided_by_supplier.net/service-tests \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Tenant: TENANT1' \
  -H 'X-Conversation-ID: string' \
  -H 'X-Request-ID: string' \
  -d '{
    "id": 23467,
    "serviceId": "SI2345432345",
    "serviceSpecification": {
      "id": "ftthl2r"
    },
    "problemType": "STABILITY"
  }'

Responses

Request was received by the supplier - result of service test will be sent 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
supplierReferencestring[ 1 .. 50 ] characters

Unique reference identifying this service test (where applicable)

Example: "A123X"
idnumber>= 1required

Unique identifier for this service test request (generated by the Fibre Cafe)

Example: 23467
serviceIdstring[ 1 .. 50 ] charactersrequired

Identifier of an existing live service

Example: "SI2345432345"
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 (if available)

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

Name of the service

Example: "FTTH"
problemTypestring(ServiceProblemType)^[A-Z_]{5,25}required

Codes representing the type of problem being encountered by the end user:

  • OUTAGE
  • PERFORMANCE
  • STABILITY
  • SYNCHRONISATION
  • CUSTOMER
  • CPE
Example: "STABILITY"
Response
application/json
{
  "supplierReference": "A123X",
  "id": 23467,
  "serviceId": "SI2345432345",
  "serviceSpecification": {
    "id": "ftthl2r",
    "name": "FTTH"
  },
  "problemType": "STABILITY"
}

Service Problem Management

Create and manage a service problem for a given line/service.

Operations