Allmänt API
Det allmänna API: et är utformat för att kunna hämta, lista, uppdatera, skapa och ta bort dataposter i systemet. Den kan användas för att automatisera processer som leverantörshantering eller skapande av design.
Modeller och åtgärder
Varje datatyp (t.ex. en cmp, en design, leverantör och så vidare) kallas en modell, varje modell ger flera åtgärder (get/list/update/...). Du kan använda samtalet till info för att få OpenAPI-specifikationen för alla modeller och åtgärder:
https://[API-Endpoint]/infoObservera att oautentiserade anrop till infomodellen kommer att resultera i en OpenAPI-specifikation för oautentiserade åtgärder. För att få alla modeller och åtgärder som är möjliga för ditt konto, vänligen autentisera först.
URL-struktur
Anrop till modeller följer strukturen:
https://[API-Endpoint]/model/[MODELNAME]/[ACTIONNAME]Exempelvis:
https://[API-Endpoint]/model/CMP/listFörutom modellanrop finns det anrop till autentisering och OpenAPI-specifikationen:
https://[API-Endpoint]/auth/[AUTH-ACTION]
https://[API-Endpoint]/infoAllmän meddelandestruktur
Kommunikation sker genom att skicka JSON-data fram och tillbaka. För att starta en åtgärd, vänligen 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 a key kan krävas för vissa åtgärder (t.ex. skapa en ny användare). Vänligen kontakta din kontoansvariga för att få din nyckel.
Viktigt: Håll din nyckel privat och överför inte den via webbläsaren utan alltid via server-till-server-anslutning!
API: et svarar med en JSON-kropp som är utformad 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: n använder följande felkoder för att signalera problem. Felkoden skickas via statuscode svarets egenskap.
| Koda | Beskrivning |
| 100-199 | Allmänna felkoder |
| 101 | Inga ingångsdata hittades |
| 102 | view / accessType saknas eller är felaktig |
| 103 | Inga ID: er skickade / ID: er ogiltiga. Vänligen skicka minst ett ID |
| 104 | Fel filter: Fält X finns inte i Y |
| 105 | åtgärden saknas eller är felaktig |
| 106 | Parameter X krävs / saknas |
| 107 | Okänd eller tom åtgärd i verktygsfältet |
| 108 | Åtgärd tillåts inte |
| 109 | Åtgärden misslyckades |
| 110 | Åtgärd tillåter inte mer än ett / eller inget ID. |
| 111 | Data för ID x hittades inte. |
| 112 | Skapa fel, se felmeddelande. Fältspecifika meddelanden se respons.data |
| 113 | Uppdateringsfel, se felmeddelande. Fältspecifika meddelanden se respons.data |
| 114 | Inga data för att skapa / uppdatera ett objekt |
| 115 | ID måste vara en matris |
| 116 | Det går inte att signera lösenordet |
| 117 | Maximal mängd objekt har överskridits |
| 200-299 | Inloggnings- / åtkomstfel |
| 201 | Annonsör avaktiverad |
| 202 | Användaren hittades inte |
| 203 | IP svartlistad |
| 204 | Fel lösenord |
| 205 | Uppgifter saknas |
| 206 | Okänt inloggningsfel |
| 207 | IP inte vitlistad |
| 208 | Passwort-ändring nödvändig (lösenord för gammalt) |
| 209 | Åtkomst är inte tillåtet |
| 210 | Lösenordsförnyelsen lyckades inte |
|
211 |
Token felaktig |
| 212 | Token har upphört att gälla |
| 213 | Kontot är inte aktivt än |
| 214 | Okänd åtkomsttyp |
| 215 | Lösenordsbyte behövs |
| 216 | Inaktiverad |
| 217 | Okänt fel |
| 218 | Autentiseringsnyckel saknas eller är tom |
| 219 | Tvåfaktorsautentisering saknas (skicka parameter 2fa) |
| 220 | Tvåfaktorautentisering felaktig |
| 221 | Två faktorer: OTP-kod saknas |
| 222 | Två faktorer: OTP-kod felaktig |
| 223 | Två faktorer: Postkod saknas |
| 224 | Två faktorer: Postkoden är felaktig |
| 225 | Två faktorer: SMS-kod saknas |
| 226 | Tvåfaktor: felaktig SMS-kod |
| 227 | Två faktorer: Mail skickas nu |
| 228 | Tvåfaktor: SMS skickas nu |
| 229 | E -postmeddelande för lösenordsuppdatering har skickats |
| 230 | lösenord uppdaterat |
| 300-399 | Interna felkoder |
| 301 | Kunde inte lösa beroendet för X på Y |
| 302 | Beroende för X resulterade i en tom lista |
| 303 | Ingen kolumn att uppdatera |
| 304 | Beroendefel på fältanvändning |
| 305 | Beroendefel på tomt fält |
| 306 | Listfrågan resulterade i en tom fältlista |
| 307 | Återuppringning av autentisering hittades inte |
| 308 | API inkludera fil hittades inte: ... |
| 399 | Allmänt internt fel |
| 900-999 | Anpassade felkoder, se meddelandet |
Åtkomsttyper
Beroende på API-struktur finns olika åtkomsttyper (JSON-fältet "accessType"). Vänligen kontakta din kontohanterare 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 tas emot / infogas från / i databasen). Ring gärna rights för att få en lista med modeller och åtgärder.
