Det allmänna API:et är utformat för att kunna hämta, lista, uppdatera, skapa och radera dataposter i systemet. Det kan användas för att automatisera processer som leverantörshantering eller designskapande.

Modeller & Åtgärder

Varje datatyp (t.ex. ett företag, en design, en leverantör osv.) kallas en modell, och varje modell erbjuder flera åtgärder (hämta/lista/uppdatera/…). Du kan använda anropet info för att få OpenAPI-specifikationen för alla modeller och åtgärder:

https://[API-Endpoint]/info

Observera att oautentiserade anrop till informationsmodellen resulterar i en OpenAPI-specifikation för oautentiserade åtgärder. För att få tillgång till alla modeller och åtgärder som är tillgängliga för ditt konto, vänligen autentisera dig först.

URL-struktur

Uppmaningar till handling följer strukturen:

https://[API-Endpoint]/model/[MODELNAME]/[ACTIONNAME]

Exempel:

https://[API-Endpoint]/model/CMP/list

Förutom modellanrop finns det anrop till autentisering och OpenAPI-specifikationen:

https://[API-Endpoint]/auth/[AUTH-ACTION]
https://[API-Endpoint]/info

Allmän meddelandestruktur

Kommunikationen sker genom att skicka JSON-data fram och tillbaka. För att starta en åtgärd, skicka en POST-begäran med följande JSON-data i HTTP-kroppen:

{
  "accessType": 1,         // Access type (may be required for authentication calls)
  "lang":       1|2|3|..., // Language (optional)  
  "kmd":        "...",     // Authentication token (optional/required depending on context)  
  "key":        "..."      // Your API-Key (optional/required depending on context)
  // other fields might be required depending on context
}

Innehållet i JSON-data kan variera beroende på vilken åtgärd som ska utföras. Se därför avsnittet Åtgärder här.

Beroende på projektets genomförande kan key krävas för vissa åtgärder (t.ex. att skapa en ny användare). Vänligen kontakta din kundansvarige för att få din nyckel.

API:et svarar med en JSON-text som är formaterad enligt följande:

{
  "status":     "...",  // Status: Success|Error 
  "statuscode": 0..999, // Status code
  "msg":        "...",  // Human readable status message
  "model":      "...",  // Context dependend. May return model type to be displayed or null
  "action":     "...",  // Action performed
  "data":        ...    // Type and content is depended on context  
}

Felkoder

API:et kommer att använda följande felkoder för att signalera problem. Felkoden skickas via statuscode egenskapen i svaret.

Åtkomsttyper

Beroende på API-strukturen finns olika åtkomsttyper (JSON-fältet "accessType"). Kontakta din kundansvarige för att få ID för den åtkomsttyp du kan använda.

Modeller

Beroende på projektet och dina åtkomsträttigheter kan du se olika modeller (datastrukturer som ska hämtas från/läggas in i databasen). Klicka här rights för att få en lista över modeller och åtgärder.