API Integration

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

Mobilplans API er et åbent, dokumenteret og lige til at give sig i kast med. Derudover, er det også gratis at benytte. Der er ingen begrænsninger for, hvad API’et kan benyttes til.

Herfra bliver det mere teknisk, og denne side er mest tiltænkt udviklere der synes, at ord som RESTful og JSON, ikke bare giver mening, men også er super fede 😉

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

Kontakt os, for at få oprettet en API nøgle. Det tager somregel ikke mere end nogle få timer, så har I adgang.

Husk at læse dokumentationen på denne side bagefter.

Opret API nøgle

RESTful er kongen

Vores API er et RESTful API.

Vi mener, at det det er den mest moderne og smidige tilgang, der samtidigt har bevist sit værd gennem mange år.

Det er samtidigt det format, der har vist sig bedst, til at lave noget af det, vi er bedst til – nemlig unikke tilpasninger af API’et, til den enkelte virksomhed.

Dynamiske skemaer

Mobilplan er yderst fleksibelt. For at holde denne fleksibiilitet på tværs af alle vores mange installationer, har vi opfundetet dynamisk skema princip.

Det tillader hvert eneste endpoint, at tage i mod en data klump, der ikke er 100% fastlagt af selve kaldet, men i stedet af den datakilde der ligger bagved.

Dette kalder vi #Schematics i dokumentationen.

Teknisk dokumentation

Alle endpoints og funktioner, kan findes i den tekniske dokumentation.

Vi anbefaler, at denne side læses grundigt, inden I går over i den tekniske dokumentation.

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

Følgende beskriver hvordan API’et skal benyttes. Der er enkelte afvigelser fra et helt standard RESTful API. Afvigelser, vi har vurderet på nøje, og fundet bedst for at kunne understøtte en meget bred vifte af systemer.

Authentication

For at kunne benytte API’et, skal følgende benyttes til authentication:

• API Key

• User

• Pass

Bemærk at User og Pass skal være til en bruger, der er oprettet via den administrative grænseflade. Denne bruge skal have administrator rettigheder.

API Key er unik for netop din integration.

Alle kald skal authenticates. Vi benytter ikke nogen tokens, til at holde et login aktivt.

Håndtering af data (Schematics data)

Alle GET, POST og PATCH kald benytter sig af ”Schematics”, enten til at definere hvad der skal indsættes/opdateres (POST/PATCH), eller til beskrivelse af det data der returneres med GET. Schematics er et term, der benyttes i Mobilplan API’et, til at beskrive en dynamisk dataset.
I skrivende stund består standard API’et af følgende Schema’s: Projects, Materials, MaterialRegistrations, MaterialCatagories, HourTypes, TimeRegistrations, Customers og Messages.

For at læse et Schema kaldes funktionen /schematics.

Eksempelvis, vil et kald til /schematics med schema: Messages, give et resultat som dette:

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

POST / PATCH

For at lave et POST / PATCH kald, sendes alt data vedr. det data der skal indsættes/opdateres, via Schemadata.
Eks.: vil et kald der opdaterer stamdata på en debitor, have følgende Schemadata:

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

Ovenstående er et simpelt key/value system, hvor key er det felt der er beskrevet i det matchende Schema og value er den værdi som feltet skal opdateres med.

Et cURL request til redigerer kunde med ID 1, vil se således ud:

curl -X PATCH "https://api-1.mps1.mobilplan.nu/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.nu%22%7D"

Request log

Alle logs til API’et bliver logget – og denne log er tilgængelig for jer som udviklere. Det er rigtig handy til både debugging og data-proofing.

Request log’en kan tilgås fra denne side: https://api-1.mps1.mobilplan.nu/documentation/apilog.php

Bemærk, at selve kaldet til log’en i sig selv også bliver logged. Dette bliver dog filtreret fra.

Har du brug for hjælp  til at integrerer med API’et?

Du kan blot bruge vores alm. support e-mail: support@mobilplan.nu, så får du hurtigt svar. Du er selvfølgelig også velkommen på hovednummeret: 8950 3000.

Det er dog lettest at få svar på tekniske spørgsmål via e-mail.