Alma API Dokumentation

Komplett dokumentation för Alma Monitor API, Alma Plan API och Alma Time API

Översikt

Alma API tillhandahåller tre huvudsakliga tjänster:

Alla API-anrop kräver autentisering via API-nyckel.

Alma Monitor API

🔑 Autentisering

Alla API-anrop kräver autentisering via API-nyckel som skickas i request headers. Kund-identifieraren (tenant) inkluderas direkt i URL:en.

Base URL: https://api.alma.insitepart.se/v1/monitor/{tenant}

Format: JSON

Obligatoriska Headers:

  • X-API-Key: {your-api-key}
  • Content-Type: application/json

Exempel URL: https://api.alma.insitepart.se/v1/monitor/your-tenant-name/measurement

Mätvärden

Hämta Mätvärde

Används för att hämta ut detaljer om ett enskilt mätvärde

GET https://api.alma.insitepart.se/v1/monitor/<tenant>/measurement

Parametrar

Parameter Beskrivning Värde Status
id Mätvärdes Id Int KRAV

Exempel Request

curl -X GET "https://api.alma.insitepart.se/v1/monitor/<tenant>/measurement?id=69" \
-H "X-API-Key: XXXX"

Exempel Respons

{
  "status": "success",
  "data": [
    {
      "Id": 69,
      "Name": "MeasurementName",
      "Description": "Description",
      "UnitId": 4,
      "UnitName": "UnitName",
      "Target": null,
      "SiteId": 1,
      "SiteName": "SiteName",
      "IsActive": false,
      "DateCreated": "2024-08-21 15:35:24",
      "DateUpdated": "2024-10-30 17:01:27"
    }
  ]
}

Mätvärde Lista

Används för att hämta ut en lista över multipla mätvärden

GET https://api.alma.insitepart.se/v1/monitor/<tenant>/measurement/list

Parametrar

Parameter Beskrivning Värde Status
siteid Id för site om man önskar filtrera på det Int FRIVILLIG

Exempel Request

curl -X GET "https://api.alma.insitepart.se/v1/monitor/<tenant>/measurement/list" \
-H "X-API-Key: XXXX"

Exempel Request (Filtrerad på Site)

curl -X GET "https://api.alma.insitepart.se/v1/monitor/<tenant>/measurement/list?siteid=1" \
-H "X-API-Key: XXXX"

Exempel Respons

{
    "status": "success",
    "count": 2,
    "data": [
        {
            "Id": 191,
            "Name": "MeasurementName",
            "Description": "Description",
            "UnitId": 1,
            "UnitName": "UnitName",
            "Target": null,
            "SiteId": 6,
            "SiteName": "SiteName",
            "IsActive": true,
            "DateCreated": "2025-02-18 13:08:16",
            "DateUpdated": "2025-02-19 16:59:04"
        },
        {
            "Id": 192,
            "Name": "MeasurementName",
            "Description": "Description",
            "UnitId": 5,
            "UnitName": "UnitName",
            "Target": null,
            "SiteId": 6,
            "SiteName": "SiteName",
            "IsActive": true,
            "DateCreated": "2025-02-18 15:51:15",
            "DateUpdated": "2025-02-18 15:51:15"
        }
    ]
}

Mätvärde Data

Används för att skicka in eller uppdatera data för ett eller flera mätvärden, för ett specifikt datum eller klockslag. Kan skickas in i enskilt record eller som en bulk transaktion.

POST https://api.alma.insitepart.se/v1/monitor/<tenant>/measurement/data

Body Parametrar

Parameter Beskrivning Värde Status
siteid Id för site Int KRAV
id Mätvärdes id Int KRAV
value Värde Int/Float KRAV
date Datum som värdet skall registreras mot Date (YYYY-MM-DD) KRAV
hour Klockslag som värdet skall registreras mot (för visuell trevlighet i tavlor bör dessa avrundas till hel/halvtimmar) Time (HH:MM:SS) FRIVILLIG

Exempel Request (Singel Post)

curl -X POST "https://api.alma.insitepart.se/v1/monitor/<tenant>/measurement/data" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: XXXX" \
  -d '{
    "data": {
      "id": 69,
      "siteid": 1,
      "date": "2025-11-19",
      "hour": "14:00:00",
      "value": 23.5
    }
  }'

Exempel Request (Bulk Post)

curl -X POST "https://api.alma.insitepart.se/v1/monitor/<tenant>/measurement/data" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: XXXX" \
  -d '{
    "data": [
      {
        "id": 69,
        "siteid": 1,
        "date": "2025-11-19",
        "hour": "14:00:00",
        "value": 23.5
      },
      {
        "id": 70,
        "siteid": 1,
        "date": "2025-11-19",
        "value": 65.8
      }
    ]
  }'

Exempel Respons

{
  "status": "success",
  "message": "Successfully processed 2 measurements",
  "results": {
    "total": 2,
    "daily_processed": 0,
    "hourly_processed": 2,
    "errors": []
  }
}

Pulsvärden

Hämta Pulsvärde

Används för att hämta ut detaljer om ett enskilt pulsvärde

GET https://api.alma.insitepart.se/v1/monitor/<tenant>/pulse

Parametrar

Parameter Beskrivning Värde Status
id Pulsvärdes Id Int KRAV

Exempel Request

curl -X GET "https://api.alma.insitepart.se/v1/monitor/<tenant>/pulse?id=5" \
  -H "X-API-Key: your-api-key"

Exempel Respons

{
    "status": "success",
    "data": [
        {
            "Id": 8,
            "Name": "PulseName",
            "Description": "Description",
            "UnitId": 3,
            "UnitName": "UnitName",
            "Target": null,
            "SiteId": 1,
            "SiteName": "SiteName",
            "IsActive": true,
            "DateCreated": "2024-10-14 08:19:32",
            "DateUpdated": "2025-09-18 11:10:40"
        }
    ]
}

Pulsvärde Lista

Används för att hämta ut en lista över multipla pulsvärden

GET https://api.alma.insitepart.se/v1/monitor/<tenant>/pulse/list

Parametrar

Parameter Beskrivning Värde Status
siteid Id för site om man önskar filtrera på det Int FRIVILLIG

Exempel Request

curl -X GET "https://api.alma.insitepart.se/v1/monitor/insitepart/pulse/list" \
  -H "X-API-Key: your-api-key"

Exempel Request (Filtrerad på Site)

curl -X GET "https://api.alma.insitepart.se/v1/monitor/insitepart/pulse/list?siteid=1" \
  -H "X-API-Key: your-api-key"

Exempel Respons

{
    "status": "success",
    "count": 2,
    "data": [
        {
            "Id": 30,
            "Name": "PulseName",
            "Description": "Description",
            "UnitId": 1,
            "UnitName": "UnitName",
            "Target": null,
            "SiteId": 6,
            "SiteName": "SiteName",
            "IsActive": true,
            "DateCreated": "2025-02-21 12:14:24",
            "DateUpdated": "2025-02-21 12:14:24"
        },
        {
            "Id": 31,
            "Name": "PulseName",
            "Description": "Description",
            "UnitId": 1,
            "UnitName": "UnitName",
            "Target": null,
            "SiteId": 6,
            "SiteName": "SiteName",
            "IsActive": true,
            "DateCreated": "2025-02-21 12:14:36",
            "DateUpdated": "2025-02-21 12:14:36"
        }
    ]
}

Pulsvärde Data

Används för att uppdatera pulsvärdesdata. Kan skickas in i enskilt record eller som bulk transaktion

POST https://api.alma.insitepart.se/v1/monitor/<tenant>/pulse/data

Body Parametrar

Parameter Beskrivning Värde Status
id Pulsvärdes id Int KRAV
value Värde Int/Float KRAV

Exempel Request (Singel Post)

curl -X POST "https://api.alma.insitepart.se/v1/monitor/<tenant>/pulse/data" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your-api-key" \
  -d '{
    "data": {
      "id": 5,
      "value": 85.5
    }
  }'

Exempel Request (Bulk Post)

curl -X POST "https://api.alma.insitepart.se/v1/monitor/<tenant>/pulse/data" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your-api-key" \
  -d '{
    "data": [
      {
        "id": 5,
        "value": 85.5
      },
      {
        "id": 6,
        "value": 92.3
      },
      {
        "id": 7,
        "value": 78.1
      }
    ]
  }'

Exempel Respons

{
    "status": "success",
    "message": "Successfully updated 2 pulse records",
    "results": {
        "total": 2,
        "updated": 2,
        "errors": []
    }
}

Alma Plan API

🔑 Autentisering

Alla API-anrop kräver autentisering via API-nyckel som skickas i request headers. Kund-identifieraren (tenant) inkluderas direkt i URL:en.

Base URL: https://api.alma.insitepart.se/v1/plan/{tenant}

Format: JSON

Obligatoriska Headers:

  • X-API-Key: {your-api-key}
  • Content-Type: application/json

Exempel URL: https://api.alma.insitepart.se/v1/plan/your-tenant-name/requirement

Planeringsbehov

Används för att skicka in behov till planeringsmodulen. Kan skickas in i enskilt record eller som bulk transaktion.

POST https://api.alma.insitepart.se/v1/plan/<tenant>/requirement

Body Parametrar

Parameter Beskrivning Värde Status
date Datum Date (YYYY-MM-DD) KRAV
starttime Starttid Time (HH:MM:SS) KRAV
endtime Sluttid Time (HH:MM:SS) KRAV
workactivityid Id på arbetsmoment Int KRAV
hours Antal timmar behov Int/Float KRAV

Exempel Request (Singel Post)

curl -X POST "https://api.alma.insitepart.se/v1/plan/<tenant>/requirement" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your-api-key" \
  -d '{
    "data": {
      "date": "2025-11-19",
      "starttime": "08:00:00",
      "endtime": "12:30:00",
      "workactivityid": 2,
      "hours": 18.5
    }
  }'

Exempel Request (Bulk Post)

curl -X POST "https://api.alma.insitepart.se/v1/plan/<tenant>/requirement" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your-api-key" \
  -d '{
    "data": [
      {
        "date": "2025-11-19",
        "starttime": "08:00:00",
        "endtime": "12:30:00",
        "workactivityid": 2,
        "hours": 18.5
      },
      {
        "date": "2025-11-19",
        "starttime": "09:00:00",
        "endtime": "13:30:00",
        "workactivityid": 4,
        "hours": 22
      }
    ]
  }'

Exempel Respons

{
  "status": "success",
  "message": "Successfully processed 2 requirement records",
  "results": {
    "total": 2,
    "processed": 2,
    "errors": []
  }
}

Alma Time API

🔑 Autentisering

Alla API-anrop kräver autentisering via PSK (Pre-Shared Key) och CustomerID (eller systemnyckeln för vissa endpoints).

Base URL: https://your-domain.com/api/apiaccess.php

Format: CSV eller JSON (specificeras med exportformat parameter)

Metod: Alla anrop görs via GET-förfrågningar

Export Tidrapporter Full

Exporterar kompletta tidrapporter med alla detaljer för en specifik kund

GET https://your-domain.com/api/apiaccess.php?mode=exporttimelogfull

Parametrar

Parameter Beskrivning Värde Status
mode Endpoint-identifierare exporttimelogfull KRAV
customerid Kund-ID Int KRAV
psk Pre-Shared Key för autentisering String KRAV
dateinfrom Startdatum för export Date (YYYY-MM-DD) FRIVILLIG
dateinto Slutdatum för export Date (YYYY-MM-DD) FRIVILLIG
exportformat Exportformat (csv eller json) csv | json FRIVILLIG

Exempel Request (CSV)

https://your-domain.com/api/apiaccess.php?mode=exporttimelogfull&customerid=123&psk=your_psk_key&dateinfrom=2025-01-01&dateinto=2025-01-31&exportformat=csv

Exempel Request (JSON)

https://your-domain.com/api/apiaccess.php?mode=exporttimelogfull&customerid=123&psk=your_psk_key&dateinfrom=2025-01-01&dateinto=2025-01-31&exportformat=json

Response Fält

Timelogid, CustomerId, CustomerName, DepartmentId, DepartmentName, ConsultantId, Firstname, Lastname, EmploymentNumber, ConsultantGroupId, ConsultantGroup, DateIn, DateOut, TimeIn, TimeOut, TotalTime, Worktime, WorktimeSec

Export Tidrapporter Summerad

Exporterar aggregerad tidrapport grupperad per avdelning och datum

GET https://your-domain.com/api/apiaccess.php?mode=exporttimelogsum

Parametrar

Parameter Beskrivning Värde Status
mode Endpoint-identifierare exporttimelogsum KRAV
customerid Kund-ID Int KRAV
psk Pre-Shared Key för autentisering String KRAV
dateinfrom Startdatum för export Date (YYYY-MM-DD) FRIVILLIG
dateinto Slutdatum för export Date (YYYY-MM-DD) FRIVILLIG
exportformat Exportformat (csv eller json) csv | json FRIVILLIG

Exempel Request

https://your-domain.com/api/apiaccess.php?mode=exporttimelogsum&customerid=123&psk=your_psk_key&dateinfrom=2025-01-01&dateinto=2025-01-31&exportformat=json

Response Fält

DepartmentId, DepartmentName, DateIn, Time (i timmar)

Export Tidrapporter Full Extra

Exporterar kompletta tidrapporter med Edited-flagga för ändringshistorik

GET https://your-domain.com/api/apiaccess.php?mode=exporttimelogfullextra

Parametrar

Parameter Beskrivning Värde Status
mode Endpoint-identifierare exporttimelogfullextra KRAV
customerid Kund-ID Int KRAV
psk Pre-Shared Key för autentisering String KRAV
dateinfrom Startdatum för export Date (YYYY-MM-DD) FRIVILLIG
dateinto Slutdatum för export Date (YYYY-MM-DD) FRIVILLIG
exportformat Exportformat (csv eller json) csv | json FRIVILLIG

Exempel Request

https://your-domain.com/api/apiaccess.php?mode=exporttimelogfullextra&customerid=123&psk=your_psk_key&dateinfrom=2025-01-01&dateinto=2025-01-31&exportformat=json

Response Fält

Timelogid, CustomerId, CustomerName, DepartmentId, DepartmentName, ConsultantId, Firstname, Lastname, EmploymentNumber, ConsultantGroupId, ConsultantGroup, DateIn, DateOut, TimeIn, TimeOut, TotalTime, Worktime, WorktimeSec, Edited

Export Tidrapporter Systemövergripande

Exporterar tidrapporter för alla kunder (kräver system-PSK)

GET https://your-domain.com/api/apiaccess.php?mode=exporttimelogfullextraallcustomers

Parametrar

Parameter Beskrivning Värde Status
mode Endpoint-identifierare exporttimelogfullextraallcustomers KRAV
psk System Pre-Shared Key (från system_settings) String KRAV
dateinfrom Startdatum för export Date (YYYY-MM-DD) FRIVILLIG
dateinto Slutdatum för export Date (YYYY-MM-DD) FRIVILLIG
exportformat Exportformat (csv eller json) csv | json FRIVILLIG

Exempel Request

https://your-domain.com/api/apiaccess.php?mode=exporttimelogfullextraallcustomers&psk=system_psk_key&dateinfrom=2025-01-01&dateinto=2025-01-31&exportformat=json

Response Fält

Timelogid, CustomerId, CustomerName, DepartmentId, DepartmentName, InternalDepartmentName, ConsultantId, Firstname, Lastname, EmploymentNumber, ConsultantGroupId, ConsultantGroup, DateIn, DateOut, TimeIn, TimeOut, TotalTime, Worktime, WorktimeSec, Edited

Export Avdelningar

Exporterar avdelningsstruktur med grupper för en specifik kund

GET https://your-domain.com/api/apiaccess.php?mode=exportdepartments

Parametrar

Parameter Beskrivning Värde Status
mode Endpoint-identifierare exportdepartments KRAV
customerid Kund-ID Int KRAV
psk Pre-Shared Key för autentisering String KRAV
exportformat Exportformat (csv eller json) csv | json FRIVILLIG

Exempel Request

https://your-domain.com/api/apiaccess.php?mode=exportdepartments&customerid=123&psk=your_psk_key&exportformat=json

Response Fält

CustomerId, CustomerName, DepartmentGroupId, DepartmentGroupName, DepartmentId, DepartmentName

Export Medarbetare

Exporterar medarbetarinformation med grupper (kräver system-PSK)

GET https://your-domain.com/api/apiaccess.php?mode=exportconsultants

Parametrar

Parameter Beskrivning Värde Status
mode Endpoint-identifierare exportconsultants KRAV
psk System Pre-Shared Key (från system_settings) String KRAV
exportformat Exportformat (csv eller json) csv | json FRIVILLIG

Exempel Request

https://your-domain.com/api/apiaccess.php?mode=exportconsultants&psk=system_psk_key&exportformat=json

Response Fält

Id, Firstname, Lastname, EmploymentNumber, TagNumber, Active, PhoneNumber1, PhoneNumber2, ConsultantFilterId, ConsultantFilterName