Vai al contenuto

Informazioni generali

Ambienti

Indirizzo pubblico di base per l’ambiente di produzione di Security

BaseUrl: https://api-security.lendingsolution.it

Indirizzo pubblico di base per l’ambiente dimostrativo dedicato esclusivamente a collaudo e testing di Security

BaseUrl: https://api-security-stg.lendingsolution.it

Route prefix

Tra l’indirizzo di base ed il nome di tutte le web API disponibili (ad es. NuovaRichiesta) è sempre presente un prefisso utilizzato per il versionamento delle route (v1, v2, etc).

Tutte le route già attualmente presenti in Security saranno preservate (ove possibile) ad eccezione del dominio e del prefisso vX.

Formato per l’interscambio dei dati con il server

Lo scambio di default con tutte le api viene fatto in formato Json quasi esclusivamente inserito nel body delle query.

Json files

Nel caso specifico dell'inserimento richieste, il Json non sarà integrato nel body delle query, ma scritto in un file JsonFile. In tale modo si potranno mandare sia i dati della richiesta che gli allegati in un unica query.

Tutti i campi non previsti dallo schema del file JSON relativo al tipo di richiesta indicato dal parametro ID_TIPO_RICHIESTA saranno ignorati (non salvati dal sistema) e non saranno soggetti a verifica da parte degli operatori. Per visionare alcuni esempi di JSON per tutte le possibili tipologie di richiesta presenti nel sistema consultare l’Appendice D.

Assicurarsi di inserire solo tipi di richiesta abilitate per il proprio profilo utente.

Formato delle date

Se non specificato diversamente tutte le date utilizzate nel sistema devono essere nel formato

AAAAMMGG

dove

  • AAAA si riferisce all’anno
  • MM si riferisce al mese della data, va riempito con uno zero a sinistra in caso di un solo carattere
  • GG si riferisce al giorno della data, va riempito con uno zero a sinistra in caso di un solo carattere
  • La data non ammette spazi bianchi, né caratteri speciali (|*/.-, ecc.)

Per esempio, il 29 luglio 2016 sarà inserito come 20160729.

HelpPage

Per aiutare allo sviluppo e l'allaccio ai Web Services, mettiamo a disposizione dei clienti una documentazione Swagger aggiornata per ogni ambiente, di cui l'indirizzo pubblico è l'indirizzo di base + /Help/index

La pagina Help contiene l’elenco delle URI disponibili, raggruppate per controller ed affiancate da una documentazione con informazioni tecniche sintetiche sull’utilizzo delle API e sui parametri da passare ai rispettivi metodi.

Nella pagina Help è possibile inoltre invocare una chiamata ed ottenere dal server un risultato utilizzando il tasto "Try it out!" come mostrato nella figura seguente:

Try it out!

Danger

Si prega di prestare attenzione all’utilizzo della pagina Help in ambiente di produzione poiché invoca i servizi reali in esercizio.