How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

KPN High Level Design FttX API

The High-Level Design FTTx API supports Fiber to the Home (FTTH) engineering jobs. It allows you to calculate the required work and cost for Fiber rollout in a provided region. Run the endpoints in this order: 1. **POST /startJobS3** to retrieve a signed URL for Amazon S3 bucket. Send this URL using the following endpoint. 2. **PUT /s3url_uploads/{jsonFileNameAndExtension}** to upload the job. 3. **GET /jobStatus/{jobId}** to retrieve the status of the job. 4. **GET / jobResultS3/{jobId}** to retrieve a signed URL for the Amazon Simple Storage Service (Amazon S3) bucket. Send this URL using the following endpoint. 5. **GET /Output/{jsonFileNameAndExtension}** to retrieve the results of the engineering job.

KPN High Level Design FttX API is one of 38 APIs that KPN publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Network, Fiber, FTTH, and Engineering. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.

This API exposes 5 operations across 5 paths, organized into 2 resource areas, and defines 26 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, https://api-prd.kpn.com/network/kpn/ftth-engineering/.

5 operations 5 paths 26 schemas 3 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://api-prd.kpn.com/network/kpn/ftth-engineering/
Authentication
OAuth 2.0
Resource Areas
2

Authentication & Security 1

KPN High Level Design FttX API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the clientCredentials flow. By default, every request must be authenticated.

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 3 GET, 1 POST, 1 PUT. They span 2 resource areas: Start engineering job, Retrieve job result. Each is listed below with its method, path, parameters, and response codes.

Start engineering job 2
POST
/startJobS3
Request a signed URL to start an FTTx engineering job.
1 param → 200400401403404429500502
PUT
/s3url_uploads/{jsonFileNameAndExtension}
Submit the input for the engineering job.
8 params body → 200
Retrieve job result 3
GET
/jobStatus/{jobId}
Returns the current status of the calculation job identified by jobId
1 param → 200400401403404429500502
GET
/jobResultS3/{jobId}
Returns a signed URL where the results of an engineering job can be retrieved.
1 param → 200400401403404429500502
GET
/Output/{jsonFileNameAndExtension}
Retrieve the results of an engineering job.
8 params → 200

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are Job (30 properties), jobResult (26 properties), address (9 properties), Trench (7 properties). Each schema is shown below with its type and property counts.

address
object
9 properties
NetworkType
string
P2P or PON to indicate what the FTTH model should do.
Job
object
The input data to be used for the engineering job, most importantly the addresses of the region for which to perform the engineering job. amongst.
30 properties
signedInputUrl
object
1 property
signedOutputUrl
object
1 property
jobStatus
object
1 property
jobResult
object
26 properties
DistributionPoint
object
4 properties 4 required
HHRoute
object
1 property
Cable96V
object
4 properties
CoreCable
object
3 properties
Pop
object
4 properties
Splitter
object
4 properties
Has
object
Has geo properties
5 properties
Trench
object
Trench properties
7 properties
Coordinate
object
Location of a point on a two-dimensional plane.
2 properties
jsonFileNameSchema
string
jsonFileNameAndExtensionSchema
string
The jobId of the engineering job you defined in /startJobS3 or /jobResultS3 with added .json extension.
amzAlgorithm
string
Identifies the version of AWS Signature and the algorithm used to calculate the signature. Use the value provided as part of the signed URL response of /startJ…
amzCredential
string
This parameter provides scope (AWS region and service) for which the signature is valid. Use the value provided as part of the signed URL response of /startJob…
amzDate
string
The date when the signedUrl was generated. Use the value provided as part of the signed URL response of /startJobS3 or /jobResultS3.
amzExpires
string
Provides the time period, in seconds, for which the generated presigned URL is valid. Use the value provided as part of the signed URL response of /startJobS3…
amzSignedHeaders
string
Lists the headers used to calculate the signature. Use the value provided as part of the signed URL response of /startJobS3 or /jobResultS3.
amzSecurityToken
string
Additional credential parameter. Use the value provided as part of the signed URL response of /startJobS3 or /jobResultS3.
amzSignature
string
The signature to authenticate your request. Use the value provided as part of the signed URL response of /startJobS3 or /jobResultS3.
error
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kpn-high-level-design-ftth-openapi.yml Raw ↑

Other APIs KPN publishes across the network.

KPN Number Verify API
KPN SIM Swap API (Account Takeover Protection)
KPN Match API
KPN SMS API
KPN SMS Inbound API
KPN Mobile Services Management API
KPN FIAM API
KPN FIAM Eneco Data Products API
KPN Disturbance Check API
KPN Internet Speed Check API
KPN LoRa Device Management API
KPN SD-LAN / SD-WAN Network View API
Where this information came from

This is an independent, third-party profile of KPN High Level Design FttX API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.