-
Notifications
You must be signed in to change notification settings - Fork 2
Update with new product names and better structure #30
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 7 commits
369af54
1735670
e60f360
013684a
56a45cc
e868cf1
45becc9
644ec9f
822f7e4
14424a3
f59c213
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| # API-Adresse- og eiendomssøk | ||
|
|
||
| ### Introduction | ||
| API-Adresse- og eiendomssøk is a REST API designed for accurate and rapid searches across multiple data sources in Norway. The service provides updated information from Norkart's synchronized copy of the land register and property register, with a maximum delay of one day. | ||
|
|
||
|  <br clear="left"/> | ||
| Implementation of the Adresse- og eiendomssøk API to enable interactive address and property search with a map. | ||
|
|
||
| ### Main Functionality | ||
| - **Autocomplete Search**: Provides immediate responses based on the entered search text. Not designed to handle typos. | ||
| - **Fuzzy Search**: Allows simple typos, offering greater flexibility. | ||
| - **Geocoding**: Validates addresses and provides details about the accuracy of the results. | ||
| - **Reverse Geocoding**: Searches for data sources based on geographical coordinates. | ||
|
|
||
| ### Data Sources | ||
| Searches can be performed against several data sources: | ||
| - **Norkart's synchronized copy of the land register and property register (Kartverket)**: | ||
| - Street addresses and streets | ||
| - Properties (Land units): Current and expired | ||
| - Owners: Organizations and individuals | ||
| - **Central Place Name Register (SSR)**: Place names | ||
| - **Other copies of data from Kartverket**: Postal zones | ||
|
|
||
| ### Handling Geographical Information | ||
| The service returns data in JSON format. For geographical information, the GeoJSON standard is used with coordinates in WGS4 (EPSG:4326). Users can specify other input and output coordinate systems. | ||
|
|
||
| ### Technical Documentation | ||
| The service is documented through Norkart's documentation portal, ensuring user-friendliness and efficient integration by testing various endpoints. Swagger/Open API documentation is available upon request. | ||
|
|
||
| ### Subscription Requirement | ||
| Please note that this service requires a subscription. For inquiries, you can contact us here: [Norkart Customer Support](https://www.norkart.no/kundestotte). | ||
|
|
||
| ### API Examples | ||
| - **Autocomplete**: It is recommended to use the `/suggest/kommunecustom` endpoint for addresses. | ||
| - **Search for more information**: Use the `/search/kommunecustom` endpoint for more detailed information, with support for fuzzy searches. | ||
|
|
||
| #### Example Request | ||
| ```http | ||
| GET https://fritekstsok.api.norkart.no/suggest/kommunecustom?targets=gateadresse&Query=Oslo&Size=1&api_key={{YOUR_API_KEY}} | ||
| Example Response | ||
| { | ||
| "Options": [ | ||
| { | ||
| "Id": "0301154490001000A000", | ||
| "Type": "gateadresse", | ||
| "Text": "Oslo gate 1A, Oslo", | ||
| "Score": 2.10001e+09, | ||
| "Url": "https://fritekstsok.api.norkart.no/data/matrikkel/adresse/gateadresse/0301154490001000A000", | ||
| "PayLoad": { | ||
| "__type": "WAAPI.FritekstSok.ServiceModel.Types.GateAdressePayLoad, WAAPI.FritekstSok.ServiceModel", | ||
| "AdresseMatrikkelNummer": "03010023400470000000", | ||
| "Text": "Oslo gate 1A, Oslo", | ||
| "AdresseId": "0301154490001000A000", | ||
| "VegAdresseId": "0301154490001A", | ||
| "Posisjon": { | ||
| "X": 10.767611078632482, | ||
| "Y": 59.90835931871215, | ||
| "SRS": 4326 | ||
| }, | ||
| "PostNummer": "0192", | ||
| "PostSted": "OSLO" | ||
| }, | ||
| "LevenshteinScore": 14, | ||
| "ExactMatches": 2 | ||
| } | ||
| ], | ||
| "TotalHits": 46, | ||
| "SRS": 4326 | ||
| } | ||
| The URL field in the response provides access to more detailed information about the address. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| # Norkart API Bakgrunnskart Documentation | ||
|
|
||
| Welcome to the documentation for Norkart API Bakgrunnskart. This service collects the most commonly used background maps needed to create a map service. This service provides access to background maps using both Tile Map Service (TMS) and Web Map Service (WMS). Below are the available map layers in this API: | ||
|
|
||
|
|
||
| | Tjenestenavn | Type | Description | url | | ||
| | ------------- | ------------- | ------------- | ------------- | | ||
| | **Maptiles** | TMS | Base map using tile service| https://waapi.webatlas.no/maptiles/{tileset}/{z}/{x}/{y}.jpeg?APITOKEN={{API_KEY}}| | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Burde komme frem at man har valg mellom flere typer karti i maptiles også; flyfoto, gråtone hybrid. Her ser det ut som man må kjøpe 4 tjenester for å få det man har i Maptiles alene
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Jeg skal få det inn i neste PR |
||
| | **WMS-STANDARKART** | WMS | Base map using Web map service| https://waapi.webatlas.no/WMS-STANDARDKART/?APITOKEN={{API_KEY}}| | ||
| | **WMS-VEKTOR-GRAY** | WMS | Grey tone base map | https://waapi.webatlas.no/WMS-VEKTOR-GRAY/?APITOKEN={{API_KEY}}| | ||
| | **WMS-Orto** | WMS | Satellitte image base map (ortographic map) | https://waapi.webatlas.no/wms-orto/?APITOKEN={{API_KEY}}| | ||
|
|
||
| <br/> | ||
|
|
||
| | <p align="center">Standard</p> | <p align="center">Grey scale</p> | <p align="center">Ortophoto</p> | | ||
| | ------------- | ------------- | ------------- | | ||
| |<img src="images/Standardkart.png" width="300" /> | <img src="images/Gråkart.png" width="300" />| <img src="images/Ortofoto.png" width="300" />| | ||
|
|
||
| ## Authentication / API Key | ||
|
|
||
| To use Norkart's map services, you will need an API key. API keys are provided on a business-to-business (B2B) basis. If you are interested in a demo or wish to request an API key, please contact us at [[email protected]](mailto:[email protected]). | ||
|
|
||
| Once you have an API key, include it in your requests as a URL parameter. For example: | ||
|
|
||
| ```bash | ||
| https://waapi.webatlas.no/maptiles/{tileset}/{z}/{x}/{y}.jpeg?APITOKEN={{API_KEY}} | ||
| ```` | ||
| Replace {{API_KEY}} with your actual API key. | ||
|
|
||
| ### Introducing TMS and WMS | ||
| #### What is Tile Map Service (TMS)? | ||
| Tile Map Service (TMS) is a standard protocol for serving maps as small image tiles. Norkart's TMS offers high-performance delivery of map tiles in XYZ format. This is ideal for rendering fast, responsive maps on web or mobile applications. You can integrate TMS into various platforms, including web frameworks like Leaflet, OpenLayers, and Mapbox, as well as desktop GIS applications.For detailed information on how to use TMS in your applications, see the [TMS subsection](../Articles/TMS/README.md). | ||
|
|
||
| #### What is Web Map Service (WMS)? | ||
| Web Map Service (WMS) is a standard protocol for requesting map images dynamically from a server. Norkart’s WMS allows users to retrieve map images in various formats (such as JPEG, PNG) and customize the rendering by specifying parameters like bounding box, zoom level, and layers. WMS is highly flexible and can be integrated into web mapping frameworks or desktop GIS systems such as QGIS and ArcGIS. For more on how to use WMS services, see the [WMS subsection](../Articles/WMS/README.md). | ||
|
|
||
| ##### Integration Guides ##### | ||
| We provide detailed guides on how to integrate our services into various systems such as QGIS, Leaflet.js, and other GIS software. | ||
|
|
||
|
|
||
| For additional help or support regarding API access or integration, reach out to [[email protected]](mailto:[email protected]). | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| # WAAPI-Takflater | ||
|
|
||
| WAAPI-Takflater provides comprehensive data about roof across Norway. This guide gives a brief overview to help developers integrate with this service. | ||
|
|
||
| ## Getting Started | ||
|
|
||
| **React Example**: [React Demo](#) - Dive into a sample React application showcasing the use of WAAPI-Takflater API. *(Note: Please replace the `#` with the actual link to your React demo if available)*. | ||
|
|
||
| ### Key Endpoints | ||
|
|
||
| #### 1. Rooftop Details by Coordinates | ||
| - **Endpoint**: `/takflater/punkt` | ||
| - **Method**: GET | ||
| - **Parameters**: `Y` (North-coordinate), `X` (East-coordinate) | ||
| - **Use Case**: Fetching rooftop details using specific geographical coordinates. | ||
|
|
||
| #### 2. Extended Rooftop Details by Coordinates | ||
| - **Endpoint**: `/takflater/punkt/utvidet` | ||
| - **Method**: GET | ||
| - **Parameters**: `Y` (North-coordinate), `X` (East-coordinate) | ||
| - **Use Case**: Fetching a more detailed view of rooftop data. | ||
|
|
||
| ### Recommendations | ||
|
|
||
| #### Suggest - Autocomplete | ||
|
|
||
| While not directly a part of the WAAPI-Takflater, it's essential to use the `/suggest/kommunecustom` endpoint for autocomplete features. This endpoint is fast and optimized for real-time suggestions. | ||
|
|
||
| #### Search - Detailed & Fuzzy Logic | ||
|
|
||
| For a more detailed view or when you expect the user might have typos or slight variations in their input, use the `/search/kommunecustom` endpoint. It's slower than suggest but offers a 'fuzzy' search logic that's lenient with variations in the input. | ||
|
|
||
| ### Example: Fetching Rooftop Data by Coordinates | ||
|
|
||
| **Request**: | ||
| \```http | ||
| GET https://waapi-takflater.api.norkart.no/takflater/punkt?Y=59.908&X=10.767&api_key={{YOUR_API_KEY}} | ||
tholar1000 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| \``` | ||
|
|
||
| **Response**: | ||
| \```json | ||
| { | ||
| "Id": 0, | ||
| "Objekttype": "string", | ||
| "ByggId": "string", | ||
| ... | ||
| } | ||
| \``` | ||
|
|
||
| Replace `{{YOUR_API_KEY}}` with your actual API key. The response provides a detailed breakdown of the rooftop based on the provided coordinates. | ||
|
|
||
| ### Further Reading | ||
|
|
||
| For an in-depth understanding, refer to the [Swagger Documentation](#). *(Note: Replace `#` with the link to your Swagger docs)*. | ||
This file was deleted.
Uh oh!
There was an error while loading. Please reload this page.