Ambita KODE

Subscribe to our email list to receive updates about our API here.

How to integrate

You want to start with finding the product you want to order, this is done by looking up the product list for a given municipality, see Get products. You can also contact support if you are unsure about what product to order, support@ambita.com.

Then make sure you are handling push notifications correctly, see Push messages.

Next you want to create an order, this is described in Create an order.

When you have created the order, you should then wait for push messages. We recommend to put push messages on a queue and process them sequentially. What to do with the different statuses is described in the Push messages, but for UPDATE and FINISHED, there is a small difference to what should be done.

When you receive an UPDATE or FINISHED push message, you should follow this 3-step procedure:

1. Use the orderId and get the order from our API described in Get order

2. Loop through assets and do necessary actions

   Files can occur on both order level and order line level.

   Example (JavaScript)

    fetch('https://beta-api.ambita.com/kode/v1/orders/:orderId')
      .then(response => {
        response.orders.forEach(order => {
          if (order.assets.length > 0) {
            // loop through order assets and do necessary actions
          }
   
          order.orderLines.forEach(orderLine => {
            if (orderLine.assets.length > 0) {
              // loop through order line assets and do necessary actions
            }
          });
        })
      });
   

3. Delete or save the file

   Response from https://beta-api.ambita.com/kode/v1/orders/:orderId

    {
      "id": 1234567,
      "status": "PROGRESS",
      ...
      "orders": [
        {
          "id": 1234567,
          "supplierName": "Infoland Kommune - demo",
          "assets": [
            ...
          ],
          ...
          "orderLines": [
            {
              "id": 12345678,
              "assets": [
                ...
              ]
   

   Take a look at the Get delivered files section, the id of the asset will be unique and should be stored in your system. Use this id as a reference to check if you have downloaded the asset before, this way you won’t end up with duplicates. You should also check the status of the asset and delete the file if it has status DELETED.

Create an order

To create an order, you need to use the access_token that you previously obtained.

Take a look at our Swagger documentation for the API here: Swagger

Send a POST request to https://beta-api.ambita.com/kode/v1/orders/cadastre

Example request

curl -s \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer ej577asf-a5k6-42yq-a3a2-fh03hb8cb58c" \
      https://beta-api.ambita.com/kode/v1/orders/cadastre -d "
        {
                \"deliveryInformation\": {
                  // delivery information object
                },
                \"orderData\": {
                  \"address\": \"Infoveien 1, 9999 Infoland\",
                  \"cadastre\": \"9999-1-1-0-0\"
                },
                \"products\": [
                  {
                    \"code\": \"WI99990033\"
                  }
                ],
                \"reference\": \"some-reference\",
                \"technicalReference\": \"some-technical-reference\"
        }"

JSON body structure

* indicates optional fields

deliveryInformation object

* indicates optional fields

orderData object

Example cadastre products orderData

"orderData": {
  "address": "Infoveien 1, 9999 Infoland",
  "cadastre": "9999-1-1-0-0"
}

Example share products orderData

"orderData": {
  "organizationNumber": 988424587,
  "shareNumber": 136
}

Example map products orderData

"orderData": {
  "geometry": {
    "type": "Polygon",
    "coordinates": [[
      [679906.435383017,7741056.419552005],
      [679906.4572162632,7742527.458934937],
      [681832.6049002217,7742527.507026337],
      [681832.6139410603,7741056.365899973],
      [679906.435383017,7741056.419552005]
    ]]
  },
  "spatialReference": "25833"
}

products array of objects

* indicates optional fields

Example map products array with additional data

"products": [
  {
    "code": "WI54016101",
    "data": {
      "format": "UTM"
    }
  }
]

Example response

{
  "id": 1664984,
  "status": "NEW",
  "priceNet": 0,
  "priceVat": 0,
  "dateOrdered": "2021-01-28T09:10:15+0100",
  "dateStatus": "2021-01-28T09:10:15+0100",
  "orders": [
    {
      "id": 2640649,
      "supplierName": "Tromsø kommune",
      "user": "Test User",
      "technicalReference": null,
      "orderLines": [
        {
          "id": 11603164,
          "status": {
            "code": "NEW",
            "name": "New order. Has not been processed yet."
          },
          "product": "WI54016101",
          "productName": "Basiskart som vektordata",
          "productType": {
            "code": "0",
            "name": "NORMAL"
          },
          "mediaType": "Datafil",
          "delivery": "Elektronisk",
          "priceNet": 0,
          "priceVat": 0
        }
      ]
    }
  ]
}

Get products

To get products, you need to use the access_token that you previously obtained.

Send a GET request to https://beta-api.ambita.com/kode/v1/products?municipality={municipalityCode}

Take a look at our Swagger documentation for the API here: Swagger

Example request

curl -s \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer ej577asf-a5k6-42yq-a3a2-fh03hb8cb58c" \
      https://beta-api.ambita.com/kode/v1/products?municipality=9999

Example response

Get order

To get an order, you need to use the access_token that you previously obtained.

Send a GET request to https://beta-api.ambita.com/kode/v1/orders/1234567

Take a look at our Swagger documentation for the API here: Swagger

Example request

curl -s \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer ej577asf-a5k6-42yq-a3a2-fh03hb8cb58c" \
      https://beta-api.ambita.com/kode/v1/orders/1234567

Example response

Push messages

In order for us to notify your system about events on an order, you need to provide a callback URL, send this to support@ambita.com

When there is an event on an order, a push message is sent to your callback URL.

These are the statuses that can be pushed to your system

Example request body

Get delivered files

Here you can find information about assets in our API

Asset object

{
  "name": "The-exact-name-of-the-file.pdf",
  "filename": "More-descriptive-name-of-the-file.pdf",
  "downloadUrl": "https://beta-api.ambita.com/shopping/v2/assets/d2f48dk9d267a86d2858244d0c2c1937",
  "assetStatus": "OK",
  "productCategory": "PRODUCT_UTEN_KATEGORI",
  "id": "d2f48dk9d267a86d2858244d0c2c1937"
}

Asset status

Product categories

Available product categories

File types

Most of the files are PDFs, but we also deliver other file types, these are the most common types:

• .pdf

• .txt

• .xlsx, .xls, .csv

• .jpg, .png

• .sos, .kof, .dxf, .dvg, .sketchup

• .tiff, .zip