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
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.
This endpoint can be called to find what appointments a supplier has available to install or maintain service(s) at a given address.
An address query parameter must be supplied specifying address ID and type along with the required service specification as returned by the /service-availability endpoint.
The next available appointments after the appointmentStartDate will be returned - a suitable date should be chosen based on installationLeadTime if this was provided during availability check.
Appointment slots are classified based on day as weekday or saturday/sunday and by time to day, AM/PM or early morning/evening. Based on the tenant-supplier agreement, some of these classifications will be considered premium.
This request will be routed to a particular supplier which must be specified.
System identifier for a supplier on the Fibre Cafe
Address identifier of provided type e.g. UPRN to check for appointment availability
Address identifier of given type
Type of address identifier e.g. UPRN, NAD, DistrictCode, ROBT
The service to be installed or maintained during this appointment
Characteristics of the service to be maintained during this appointment e.g. SERVICE_ID, CARE_LEVEL
Find appointment slots from this date
Find appointment slots classified as standard only (exclude premium time slots)
Purpose of the appointment : PROVIDE, MODIFY, REPAIR
curl -i -X GET \
'https://prod.fibregateway.com/v1/available-appointments?supplier=DUMMY_SUPPLIER&address={%22id%22%3A%22200004033694%22%2C%22type%22%3A%22UPRN%22}&serviceSpecification={%22id%22%3A%22ftthl2r%22}&serviceCharacteristics=%5B{%22name%22%3A%22LINE_PROFILE%22%2C%22value%22%3A%221G1G%22}%5D&appointmentFromDate=2022-01-05&standardOnly=false&singleDayAppointment=false&appointmentPurpose=PROVIDE&serviceId=SI2345432345345' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'X-Conversation-ID: string' \
-H 'X-Request-ID: string'Request successful - zero or more available appointments were returned
Unique identifier to identify request and response events across the Fibre Cafe gateway
System identifier for a supplier on the Fibre Cafe that is providing this appointment
Address identifier for location including type of identifier.
Address identifier of given type
Type of address identifier e.g. UPRN, NAD, DistrictCode, ROBT
Details of a service the supplier provides at the selected address.
List of available appointment timeslots
Start date/time for this timeslot
End date/time for this timeslot
Timeslot classification:
{ "supplier": "SUPPLIER1", "address": { "id": "A00000031882", "type": "NAD", "additionalIdentifiers": [ … ] }, "serviceSpecification": { "id": "ftthl2r", "name": "FTTH" }, "availableTimeslots": [ { … } ] }
This endpoint can be called to reserve an appointment with a supplier to install or maintain service(s) at a given address.
Details of a previously returned available appointment must be provided to be reserved according to the supplier reservation policy. Where the reservation has a TTL (time to live) before being released, the expiry time will be stated.
The returned reservation ID must be sent as part of the order at which point it should be considered confirmed.
System identifier for a supplier on the Fibre Cafe that is associated with this appointment
Address identifier for location including type of identifier.
Address identifier of given type
Type of address identifier e.g. UPRN, NAD, DistrictCode, ROBT
Details of a service the supplier provides at the selected address.
List of service characteristics for the appointment - e.g. CARE_LEVEL
Identifier of an existing live service, mandatory for REPAIR appointments
Purpose of the appointment : PROVIDE, MODIFY, REPAIR
Represents an appointment timeslot with a supplier.
curl -i -X POST \
https://prod.fibregateway.com/v1/appointments \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-H 'X-Conversation-ID: string' \
-H 'X-Request-ID: string' \
-d '{
"supplier": "SUPPLIER1",
"address": {
"id": "A00000031882",
"type": "NAD",
"additionalIdentifiers": [
{
"id": "A00000031882",
"type": "NAD"
}
]
},
"serviceSpecification": {
"id": "ftthl2r"
},
"serviceCharacteristics": [
{
"name": "LINE_PROFILE",
"value": "1G1G"
}
],
"serviceId": "SI2345432345345",
"purpose": "PROVIDE",
"timeslot": {
"timeslotStartDateTime": "2022-01-10T09:00:00.000Z",
"timeslotEndDateTime": "2022-01-10T13:00:00.000Z"
}
}'Operation successful - appointment was reserved. Returned ID to be used when placing order
Unique identifier to identify request and response events across the Fibre Cafe gateway
Appointment reference generated by the supplier (for information only)
Where an appointment is reserved, this contains the date/time when the reservation will expire.
System identifier for a supplier on the Fibre Cafe that is associated with this appointment
Address identifier for location including type of identifier.
Address identifier of given type
Type of address identifier e.g. UPRN, NAD, DistrictCode, ROBT
Details of a service the supplier provides at the selected address.
List of service characteristics for the appointment - e.g. CARE_LEVEL
Identifier of an existing live service, mandatory for REPAIR appointments
Purpose of the appointment : PROVIDE, MODIFY, REPAIR
Represents an appointment timeslot with a supplier.
Start date/time for this timeslot
End date/time for this timeslot
Timeslot classification:
{ "id": 345, "supplierReference": "123456543", "expiryDateTime": "2022-01-01T13:45:00.000Z", "supplier": "SUPPLIER1", "address": { "id": "A00000031882", "type": "NAD", "additionalIdentifiers": [ … ] }, "serviceSpecification": { "id": "ftthl2r", "name": "FTTH" }, "serviceCharacteristics": [ { … } ], "serviceId": "SI2345432345345", "purpose": "PROVIDE", "timeslot": { "timeslotStartDateTime": "2022-01-10T09:00:00.000Z", "timeslotEndDateTime": "2022-01-10T13:00:00.000Z", "classification": "SATURDAY_AM", "standard": true } }