API Integration i Mobilplan

Hvad kan et API?

Et API (Application Programming Interface) gør det muligt for to programmer at tale sammen og udveksle data.

Mobilplans API er åbent, dokumenteret og til at gå til, og det er gratis at bruge. Det bruges fx til at koble Mobilplan sammen med Business Central eller Uniconta, enten af jeres egne udviklere eller af en integrationspartner.

Herfra bliver det mere teknisk. Resten af siden er skrevet til udviklere, der arbejder med RESTful og JSON.

Kom i gang

For at lave en API-integration skal I bruge en API-nøgle.

Kontakt os for at få oprettet en API-nøgle. Som regel har I adgang inden for få timer.

Læs resten af denne side, før I går i gang.

Opret API-nøgle

Teknisk tilgang

Et RESTful API

Vores API er et RESTful API.

Det er en udbredt og gennemprøvet tilgang, som de fleste udviklere kender i forvejen.

Formatet passer også til den måde, Mobilplan bruges på: Hver virksomhed har sin egen opsætning, og API’et følger med.

Dynamiske skemaer

Mobilplan er forskelligt sat op fra virksomhed til virksomhed. For at API’et kan følge med på tværs af alle installationer, bruger vi dynamiske skemaer.

Det betyder, at de data, et endpoint tager imod og returnerer, ikke er låst fast af selve kaldet. De bestemmes af datakilden bagved, altså jeres opsætning.

Det kalder vi #Schematics i dokumentationen.

Teknisk dokumentation

Alle endpoints og funktioner står i den tekniske dokumentation.

Læs denne side grundigt, før I går over i den tekniske dokumentation.

Den tekniske dokumentation findes her: https://api-1.mps1.mobilplan.dk/documentation/index.html

Designprincipper

Her er, hvordan API’et skal bruges. På enkelte punkter afviger det fra et helt standard RESTful API. Det er bevidste valg, så API’et kan bruges af mange forskellige systemer.

Autentificering

Hvert kald autentificeres med:

API Key
User
Pass

Bemærk, at User og Pass skal høre til en bruger, der er oprettet i administrationen, og brugeren skal have administratorrettigheder.

API Key er unik for jeres integration.

Alle kald skal autentificeres. Vi bruger ikke tokens til at holde et login aktivt.

Håndtering af data (Schematics)

Alle GET-, POST- og PATCH-kald bruger Schematics, enten til at definere, hvad der skal indsættes eller opdateres (POST/PATCH), eller til at beskrive de data, der returneres med GET. Schematics er betegnelsen i Mobilplans API for et dynamisk datasæt.
I skrivende stund består standard-API’et af disse schemas: Projects, Materials, MaterialRegistrations, MaterialCatagories, HourTypes, TimeRegistrations, Customers og Messages.

Et schema læses med funktionen /schematics.

Et kald til /schematics med schema: Messages giver fx dette resultat:

[
  {
    "Field": "id",
    "Type": "int(11) unsigned",
    "Null": "NO",
    "Key": "PRI",
    "Default": null,
    "Extra": "auto_increment",
    "Readonly": true,
    "Deprecated": false,
    "Mandatory": false
  }
]

POST / PATCH

Ved et POST- eller PATCH-kald sendes alle data, der skal indsættes eller opdateres, i Schemadata.
Et kald, der opdaterer stamdata på en debitor, kan fx have dette Schemadata:

{"name": "Mobilplan", "email": "hej@mobilplan.nu"}

Det er et simpelt key/value-system, hvor key er feltet, som det er beskrevet i det tilhørende schema, og value er den værdi, feltet skal have.

Et cURL-request, der redigerer kunden med ID 1, ser sådan ud:

curl -X PATCH "https://api-1.mps1.mobilplan.dk/customer/1" -H "accept: application/json" -H "Username: [USER]" -H "Password: [PASSWORD]" -H "APIKey: [APIKey]" -H "Content-Type: application/x-www-form-urlencoded" -d "Schemadata=%7B%22name%22%3A%20%22Mobilplan%22%2C%20%22email%22%3A%20%22hej%40mobilplan.dk%22%7D"

Log over kald

Alle kald til API’et bliver logget, og loggen er tilgængelig for jer som udviklere. Det er nyttigt både til fejlsøgning og til at dokumentere, hvilke data der er sendt.

Loggen finder I her: https://api-1.mps1.mobilplan.dk/documentation/apilog.php

Bemærk, at kaldet til selve loggen også bliver logget, men det bliver filtreret fra.

Brug for hjælp?

Har I brug for hjælp til at integrere med API’et?

Skriv til vores support: support@mobilplan.nu, så får I hurtigt svar. I er også velkomne til at ringe på hovednummeret: 8950 3000.

Tekniske spørgsmål er dog lettest at besvare på e-mail.

API-integration