Documentazione API

L'utilizzo di questa API è limitato ai programmatori e alle persone con conoscenze tecnologiche avanzate. Qualsiasi funzionalità che si desideri eseguire tramite l'API può essere eseguita anche tramite l'interfaccia Web, quindi se non disponi di conoscenze tecnologiche, prova a utilizzare l'interfaccia Web.

Per potersi identificare con la nostra API è necessario il token di autenticazione. Tieni presente che vedrai queste informazioni solo se hai effettuato l'accesso alla pagina e che questi dati sono esclusivi del tuo account e non personali, non condividerli con nessuno al di fuori della tua organizzazione. I dati che devono essere inclusi in tutte le chiamate sono:

Devi essere loggato per vedere questi valori Entra qui.

La nostra API è in formato REST, quindi è indipendente dalla lingua che verrà utilizzata. Le chiamate vengono sempre effettuate sul seguente endpoint:

https://acumbamail.com/api/1/(nombreFuncion)/

E questo endpoint è quello a cui verranno passati i parametri di input. Il nostro consiglio, dato che nella maggior parte dei casi verranno apportate modifiche ai dati archiviati nel database, è di utilizzare POST, sebbene abbiamo anche la capacità di supportare chiamate in formato GET..

Tutte le funzioni, oltre ai dati che possono essere restituiti in risposta alla richiesta, restituiranno anche un codice di stato html che potremo acquisire. C'è un codice diverso per ogni situazione e i codici sono i seguenti:

• Codice di stato

• 200

  La consultazione ha avuto successo

• 201

  I dati sono stati modificati correttamente

• 400

  Richiesta errata: un qualche argomento è risultato errato

• 401

  Non autorizzato, il processo di autenticazione è stato errato

• 429

  Troppe richieste a una funzione in un periodo di tempo

• 500

  Si è verificato un errore sul server. Fatecelo sapere così possiamo risolverlo

In alcuni casi viene richiesto un dizionario come parametro di input per i metodi. Nel caso delle chiamate POST, tutti i parametri devono andare nel corpo come dati del modulo, per codificare un dizionario nella chiamata GET sarebbe un esempio:

https://acumbamail.com/api/1/(nombreFuncion)/?dict[key]=value&dict[key1]=value1&dict[key2]=value2

E questo endpoint è quello a cui verranno passati i parametri di input. Il nostro consiglio, dato che nella maggior parte dei casi verranno apportate modifiche ai dati archiviati nel database, è di utilizzare POST, sebbene abbiamo anche la capacità di supportare chiamate in formato GET..