API

Introduktion

Det här dokumentet beskriver hur du använder vårt REST API för att integrera med vårt system. API ger åtkomst till funktionalitet såsom att skapa försäljningsorder. API:et utvecklas kontinuerligt och fler resurser läggs in.

Autentisering och auktorisering

För att använda API behöver du autentisera dig med en giltig API-nyckel. Autentisering sker genom OAuth 2.0, och varje anrop kräver en Bearer Token i Authorization-huvudet.

Din klient behöver registreras i GKS4 vilket är något Simutek hjälper till med. Därefter får du ett client_id och en client_secret som används för att erhålla en åtkomsttoken.

Exempel på hämtning av åtkomsttoken

curl

Ett exempel hur access token kan hämtas med curl.

curl 'https://id.simutek.se/connect/token' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'client_id=your_client_id' \
  --data-urlencode 'client_secret=your_client_secret' \
  --data-urlencode 'grant_type=client_credentials'

Python

Ett exempel hur access token kan hämtas med Python 3 och Requests.

get_access_token.py

import requests

def fetch_access_token():
    url = "https://id.simutek.se/connect/token"
    headers = {
        "Content-Type": "application/x-www-form-urlencoded"
    }
    data = {
        "client_id": "YOUR_CLIENT_ID",
        "client_secret": "YOUR_CLIENT_SECRET",
        "grant_type": "client_credentials"
    }
    
    response = requests.post(url, headers=headers, data=data)

    if response.status_code == 200:
        access_token = response.json().get("access_token")
        print(f"Access Token: {access_token}")
    else:
        print(f"Failed to fetch access token. Status Code: {response.status_code}")
        print(response.text)

if __name__ == "__main__":
    fetch_access_token()

För att köra koden:

pip3 install requests
python3 get_access_token.py

JavaScript (Node.js)

Ett exempel hur access token kan hämtas med JavaScrpt (Node.Js):

const axios = require('axios');
const qs = require('qs'); // For URL-encoded data

async function fetchAccessToken() {
  const url = 'https://id.simutek.se/connect/token';
  const data = qs.stringify({
    client_id: 'YOUR_CLIENT_ID',
    client_secret: 'YOUR_CLIENT_SECRET',
    grant_type: 'client_credentials'
  });

  try {
    const response = await axios.post(url, data, {
      headers: {
        'Content-Type': 'application/x-www-form-urlencoded',
      },
    });

    console.log('Access Token:', response.data.access_token);
  } catch (error) {
    console.error('Failed to fetch access token:', error.response ? error.response.data : error.message);
  }
}

fetchAccessToken();

För att köra koden:

npm install axios qs
node fetchAccessToken.js

Dokumentation

Places a sales order.

POST/api/v1/salesorders

Body

application/json

The sales order to create.

customerNumber*string

The customer number in GKS of the buyer. A company with this customer number must exist in GKS.

Example: "K100421"

billingContact*ContactInfo (object)

billingCompanyInfo*nullable any of

nullCompanyInfo (object)

billTo*nullable any of

nullAddress (object)

shipTo*nullable any of

nullRecipient (object)

orderTitle*nullable string

Optional name of the sales order that will be useful when searching for the order.

promisedDeliveryDate*nullable string (date-time)

ordered*nullable string (date-time)

Obsolete. We do not see a business need to change the date of purchase. It should always be the same date as the order request is received.

purchaseOrderNumber*string

An optional purchase order number from the buyer. In PlaceSimpleOrder API, "CustOrderNo".

isExport*boolean

isExportWithinEu*boolean

languageCode*nullable string

The preferred language (ISO 639-1) of documents communicated with the buyer, i.e. order confirmation. Accepted values: sv, no, en

currencyCode*nullable string

The currency of the amounts in this sales order. ISO 4217.

Example: "SEK"

noteFromCustomer*nullable string

A comment added by the customer during placement of the order. Commonly with instructions to the seller.

salesOrderlines*array of SalesOrderline (object)

hasAllotments*boolean

Response

200400404500

Success. The sales order was created.

Body

application/json

orderNumber*integer (int32)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/salesorders', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "billingContact": {
        "eInvoiceCode": "text",
        "email": "text",
        "firstName": "text",
        "lastName": "text",
        "phone": "text",
        "phoneMobile": "text"
      },
      "currencyCode": "SEK",
      "customerNumber": "K100421",
      "hasAllotments": false,
      "isExport": false,
      "isExportWithinEu": false,
      "languageCode": "text",
      "noteFromCustomer": "text",
      "ordered": "2024-10-18T08:40:17.964Z",
      "orderTitle": "text",
      "promisedDeliveryDate": "2024-10-18T08:40:17.964Z",
      "purchaseOrderNumber": "text",
      "salesOrderlines": [
        {
          "allotments": [
            {
              "shipTo": {
                "address": {
                  "address1": "Storgatan 1",
                  "address2": "Garageinfart 2",
                  "address3": "text",
                  "city": "Stockholm",
                  "countryCode": "SE",
                  "state": "FL",
                  "zipCode": "114 44"
                },
                "contactEmail": "text",
                "contactMobilePhone": "text",
                "contactName": "text",
                "recipientName": "text"
              }
            }
          ],
          "articleNumber": "text",
          "costMaterial": 0,
          "costSubcontractWork": 0,
          "costWork": 0,
          "description": "text",
          "profitCenterCode": "14",
          "salesUnit": "text",
          "shipOrderline": false,
          "unitPrice": 0
        }
      ]
    }),
});
const data = await response.json();

Response

200400404

{}