L'API generale è progettata per poter recuperare, elencare, aggiornare, creare ed eliminare voci di dati nel sistema. Può essere utilizzata per automatizzare processi come la gestione dei fornitori o la creazione di progetti.

Modelli e azioni

Ogni tipo di dato (ad es. un cmp, un design, un vendor e così via) è chiamato modello; ogni modello fornisce diverse azioni (get/list/update/…). Puoi utilizzare la chiamata a info per ricevere le specifiche OpenAPI di tutti i modelli e le azioni:

https://[API-Endpoint]/info

Si prega di notare che le chiamate non autenticate al modello info daranno come risultato una specifica OpenAPI per le azioni non autenticate. Per ottenere tutti i modelli e le azioni disponibili per il tuo account, ti preghiamo di autenticarti prima.

Struttura degli URL

Le call to action seguono la struttura:

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

Esempio:

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

Oltre alle chiamate al modello, ci sono chiamate all'autenticazione e alle specifiche OpenAPI:

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

Struttura generale del messaggio

La comunicazione avviene tramite lo scambio di dati JSON. Per avviare un'azione, invia una richiesta POST con i seguenti dati JSON nel corpo HTTP:

{
  "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
}

Il contenuto dei dati JSON può variare a seconda dell'azione da eseguire. Pertanto, consulta la sezione Azioni qui.

A seconda dell'implementazione del progetto, key potrebbe essere richiesta per determinate azioni (ad es. la creazione di un nuovo utente). Ti preghiamo di contattare il tuo account manager per ricevere la tua chiave.

L'API risponderà con un corpo JSON formattato come segue:

{
  "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  
}

Codici di errore

L'API utilizzerà i seguenti codici di errore per segnalare eventuali problemi. Il codice di errore viene inviato tramite la statuscode proprietà della risposta.

Tipi di accesso

A seconda della struttura dell'API esistono diversi tipi di accesso (campo JSON "accessType"). Contatta il tuo account manager per ricevere l'ID del tipo di accesso che puoi utilizzare.

Modelli

A seconda del progetto e dei tuoi diritti di accesso, potresti vedere diversi modelli (strutture di dati da ricevere/inserire da/nel database). Clicca su "Azione" rights per ricevere un elenco di modelli e azioni.