VETRO FiberMap® uses a RESTful API to interact with its underlying data structure. It utilizes standard HTTP requests and, whenever applicable, accepts application/json requests and responds with JSON objects.
\nThe API is built following the OpenAPI 3.0 specification. A yaml file describing the API can be downloaded here.
\nVETRO FiberMap uses HTTP requests and mostly adheres to the idea of RESTful verbs to send and retrieve data. Authentication and authorization for requests is handled via basic HTTP authentication using either login sessions or access tokens (See below).
\nGET or DELETE requests will usually include required data as parameters as part of the URL address. For example, retrieving information around a specific location may require the location's latitude and longitude, as in /api/layer/geometriesNear/-73.45/44.2341.
\nOptional parameters will usually use a querystring key/value parameter after the URL. For example, the previous request uses a default search radius of 50 meters, but you can change that value by include a query parameter, like this: /api/layer/geometriesNear/-73.45/44.2341?radius=100. All optional parameters are described in the documentation for each API endpoint.
\nAll POST requests should use the header Content-type: application/json along with any required data using a raw JSON-formatted body. POST requests do not generally accept form style key-value requests.
Almost all APIs return JSON data, nearly always following this format:
\n{\n \"success\": true,\n \"result\": (data)\n}\n(data) will be whatever you're asking for: the identity of a object on your network, or a set of utility poles, for instance. It may be as simple as a boolean indicating whether an operation did what you asked.
Failures will normally respond with a non-200 error code, usually 400 for errors in the request, or 500 for internal issues.
> POST /api/(async endpoint) HTTP/1.1\n> Host: vetro.io\n> Content-type: application/json\n> Content-Length: 12345\n...\n\nResult:\n{\n \"success\": true,\n \"result\": {\n \"status\": \"started\",\n \"id\": \"status_id_uuid\",\n \"resultsURL\": \"/api/(async endpoint)/status/status_id_uuid\",\n }\n}\n\n> GET /api/(async endpoint)/status/status_id_uuid\n\nResult:\n{\n \"success\": true,\n \"result\": {\n \"status\": \"in progress\",\n \"detail\": \"Done with part X\",\n \"id\": \"status_id_uuid\",\n \"resultsURL\": \"/api/(async endpoint)/status/status_id_uuid\",\n }\n}\n\n> GET /api/(async endpoint)/status/status_id_uuid\n\nResult:\n{\n \"success\": true,\n \"result\": {\n \"status\": \"complete\",\n \"id\": \"status_id_uuid\",\n \"resultsURL\": \"/api/(async endpoint)/results/status_id_uuid\",\n }\n}\n\n> GET /api/(async endpoint)/results/status_id_uuid\n\n(Retrieves the results, whether a .zip file, .csv or anything else, depending on the endpoint!)\nCertain endpoints refer to Asynchronous Jobs and do not return immediate results. These are generally used for long-running or complex requests that cannot be handled within the timeframe of a normal HTTP request.
\nInstead, VETRO FiberMap enables job-based requests that return an immediate \"accepted\" response that includes a status URL. That URL should be used to periodically check the runtime status of the asynchronous job - usually there will be \"progress reports\" along the way, explaining that the job is underway, waiting for some further processing, or complete.
\nOnce complete, that status URL will return a response URL that should be used to retrieve the results of the initial request.
\nFollow along with the example to the right.
\nSome VETRO FiberMap API endpoints require some more intensive server processing. In these cases, there will be usage limits applied. If you hit these API endpoints too many times within a certain timespan, the API endpoint will return a 429 error code, with messaging similar to:\n\"Too many requests per second, please slow down the number of concurrent requests.\"
layer_id value. Searching for other endpoints that offer layer_id as an input parameter can give you hints where to use it.Please note that this public API is provided for your use in accessing your network and related non-network data. While we are happy to assist you in understanding the parameters that go into requests to this API or the answers that result, we can provide only advisory support for whatever application is using this data other than VETRO FiberMap.
\nPlease contact us through support@vetrofibermap.com if you have any questions or concerns!
\nThis documentation was generated on Thu, 17 Jun 2021 18:11:08 GMT.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Welcome!","slug":"welcome"}],"owner":"11528456","collectionId":"cd63154f-49cf-4a36-baa2-108485651f99","publishedId":"2sAYX5MiJt","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-02-04T18:27:56.000Z"},"item":[{"name":"address","item":[{"name":"match","item":[{"name":"{address}","item":[{"name":"Get similar valid addresses","id":"e4e4cdb1-9a98-4fc8-b0f9-da845902c060","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/v2/address/match/:address?center=Center
\n","type":"text/plain"},"key":"center","value":"Radius in meters
\n","type":"text/plain"},"key":"radius","value":"Return locations other than street level addresses (ie. cities, states)
\n","type":"text/plain"},"key":"allow_any_location","value":"(Required) Address
\n","type":"text/plain"},"type":"any","value":"(Required) The id of the layer to export
\n","type":"text/plain"},"type":"any","value":"(Required) The file format with which to export the features
\n","type":"text/plain"},"type":"any","value":"geojson","key":"format"}]}},"response":[{"id":"1c0af84b-1826-4283-8616-c69d66dcd896","name":"A signed s3 url that can be used to download the exported layer","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"vetro_session","value":"(Required) The id of the plan to export
\n","type":"text/plain"},"type":"any","value":"(Required) The file format with which to export the features
\n","type":"text/plain"},"type":"any","value":"geojson","key":"format"}]}},"response":[{"id":"9ea048be-7e56-456a-858e-9dd7bf7e9915","name":"A signed s3 url that can be used to download the exported plan","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"vetro_session","value":"