Skip to content

Commit

Permalink
Updatedocs (#26)
Browse files Browse the repository at this point in the history
* update frontpage

* remove swaggerlink

* remove matrikkelkart swaggerlink
  • Loading branch information
laaaders authored Jun 7, 2023
1 parent 0b42947 commit 753267e
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 20 deletions.
2 changes: 0 additions & 2 deletions API-fritekstsok/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# API-Fritekstsok
Fritekstsok exposes the most updated addresses in Norway.

Swagger: [Fritekstsok-Swagger](https://fritekstsok.api.norkart.no/swagger-ui/)

## Code examples and tutorials
- [Getting Started](./../code_and_tutorials/getting%20started%20-%20fritekstsok)
- [React Example:](./../code_and_tutorials/reactleaflet_fritekstsok_maptiles_matrikkelkart_example) In this demo you can see fritekstsøk used in a simple React application.
Expand Down
4 changes: 1 addition & 3 deletions API-matrikkelkart/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

MatrikkelKart API exposes geographic information about Matrikkelenheter and Teiger. (Matrikkel is the Norwegian cadaster system)

Swagger: [Matrikkelkart-Swagger](https://matrikkelkart.api.norkart.no/swagger-ui/)

## Example: Get matrikkel information by coordinate
To get matrikkel information for the a point with coordinates: latitude: 63.4267428, longitude: 10.3981875

Expand Down Expand Up @@ -73,4 +71,4 @@ In either case, the response will be identical to the example above that queries

## Getting started

- [React Example:](https://github.com/Norkart/API-documentation/tree/main/code_and_tutorials/reactleaflet_fritekstsok_maptiles_matrikkelkart_example) In this demo you can see matrikkelkart used in combination with fritekstsok and maptiles in a simple React application.
- [React Example:](https://github.com/Norkart/API-documentation/tree/main/code_and_tutorials/reactleaflet_fritekstsok_maptiles_matrikkelkart_example) In this demo you can see matrikkelkart used in combination with fritekstsok and maptiles in a simple React application.
21 changes: 6 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,33 @@
# Norkart API Documentation

This is our collection of developer documentation, examples and tutorials for several of our public API offerings. See https://www.norkart.no/dataoganalyse/ for product listings, API-keys, contact and support.
This is our collection of developer documentation, examples and tutorials for some of our public API offerings. See https://www.norkart.no/dataoganalyse/ for product listings, API-keys, contact and support.

See [code and tutorials](code_and_tutorials) for complete list of code-snippets, examples and tutorials.

## Documented API's:
## Documented API's at github:

* [API-maptiles](API-maptiles)
* [API-fritekstsok](API-fritekstsok)
* [API-matrikkelkart](API-matrikkelkart)
* [API-datavarehus](API-datavarehus)

## About API's
Norkarts services are mostly ```REST-services``` which support data-exchange in JSON, XML and ServiceStack CSV-format. Where ```JSON is the reccomendation```.

All API's have the following charachteristics:
- Metadata enpoint: ```{url}/metadata```. Example: [Fritekstsok-Metadata](https://fritekstsok.api.norkart.no/metadata)
- Swagger endpoint: ```{url}/swagger-ui```. Example: [Fritekstsok-Swagger](https://fritekstsok.api.norkart.no/swagger-ui/)
- Postman endpoint: ```{url}/postman```. Example: [Fritekstsok-Postman](https://fritekstsok.api.norkart.no/postman)
Norkarts services are mostly ```REST-services``` which support data-exchange in JSON.

## About Map Services
There are two types of map services:
- Tile Map Service (```TMS```):
- Web Map Service (```WMS```)

Read more about [API-maptiles](API-maptiles)
Read more about [Web-Map-Services-(WMS)](WMS)
- [Tile-Map-Services](API-maptiles) (```TMS```):
- [Web-Map-Services](WMS) (```WMS```)


## Authentication / API key
Authentication works in the same way for all services.
- Example: ```https://fritekstsok.api.norkart.no/suggest/matrikkel/adresse?Query=Oslovei&api_key={{YOUR_API_KEY}}```

Request API access [here](https://www.norkart.no/dataoganalyse/).

## Live Demos
- [Norkart API Demo](https://mango-flower-0fd4d4b03.azurestaticapps.net/): Here you can see a minimalistic map application that uses maptiles, fritekstsøk and matrikkelkart APIs.

Request API access [here](https://www.norkart.no/dataoganalyse/).



0 comments on commit 753267e

Please sign in to comment.