Descrizione del servizio API

Descrizione del servizio API

Modalità di accesso

Tutte le chiamate api devono includere un apiKey.

Ogni utente può generare più apiKey all'interno della propria area riservata.



Modalità di acquisto tramite API

Gli acquisti tramite API andranno a scalare crediti da uno specifico pacchetto acquistato in precedenza.
Per ogni servizio è previsto uno specifico listino prezzi.


Es.


VISURE

100

XXX Euro

250

YYY Euro

500

ZZZ Euro



Acquisto di opzioni

E' possibile che su alcuni tipi di ordini siano previste delle opzioni a pagamento.
In questo caso il valore in crediti che viene scalata sarà superiore a 1.


 ordine base

 1 credito

 ordine + opzione a pagamento

 1 credito + costo opzione

L'acquisto di un ordine base (su cui non è stata attivata una opzione a pagamento) farà scalare un valore in crediti uguale 1.
L'acquisto di un ordine su cui è stata attivata una opzione a pagamento farà scalare un valore in crediti superiore a 1.

Chiamate sincrone e asincrone

I servizi indicati come "sincroni" restituiscono subito il dato richiesto.
I servizi indicati come "asincroni" restituiscono il risultato richiesto in un secondo tempo.

Struttura di base delle chiamate Api 

Per ogni documento richiedibile sono disponibili grossomodo le queste chiamate.


es. VISURE


POST Catasto/VISURE/Crea 

Crea la visura e inizia a processarla.

Restituisce l’id dell’ordine creato


GET Catasto/VISURE/XXYY/

Restituisce i dati dell’ordine di visura


GET Catasto/VISURE/XXYY/Download

La chiamata restituirà il documento della visura


Interfaccia Swagger

E' disponibile l'interfaccia swagger dove poter prendere visione di tutti i parametri richiesti dalle varie chiamate.

Errori


Nel caso in cui l’elaborazione fallisca, il sistema annullerà l’ordine (verrà quindi recuperato quanto speso) e riporterà il motivo dell’errore.
Diversamente dalla procedura tramite interfaccia che consente all’utente di poter modificare un ordine e riavviarlo, via api non sarà possibile modificare un ordine già inviato ma se ne dovrà lanciare uno nuovo.


Riportiamo qui un esempio di possibili errori nel caso di processamento di una visura:


Dati catastali incompleti

Ad esempio manca il subalterno laddove è richiesto per l’individuazione di un immobile. 

Diversamente dalla richiesta eseguita tramite interfaccia, dove viene proposto all’utente di selezionare un subalterno tra quelli disponibili, il sistema non restituirà l’elenco dei subalterni e sarà comunque necessario creare un nuovo ordine per poter proseguire con l’elaborazione.


Laddove si rendesse necessario acquisire il dato del subalterno corretto è possibile procedere nei seguenti modi sfruttando apposite chiamate API:

  1. richiedere un elenco dei subalterni 

  2. richiedere un elaborato planimetrico 

  3. richiedere l’elenco degli immobili di proprietà del soggetto intestato


Dati catastali errati

Nel caso i dati siano errati, l’ordine verrà annullato.

Sarà possibile cercare di recuperare i dati catastali corretti tramite la ricostruzione dei dati catastali dell’immobile partendo dalla sua posizione / indirizzo oppure utilizzando le chiamate API del punto precedente


Dati corretti ma più sub

L’utente fornisce correttamente i dati catastali necessari ma vengono rilevati più immobili (es uno soppresso e uno non soppresso, capita ad esempio quando la particella è graffata e cambia il numero della particella graffata)
In questo caso il sistema esegue la visura sull’immobile non soppresso.

    • Related Articles

    • Ordini massivi

      Introduzione Il sistema di ordini massivi semplifica e riduce il tempo necessario per eseguire più ordini. Invece di creare ed acquistare un ordine alla volta, è sufficiente caricare online un file Excel (o CSV) con i dati da processare ed il sistema ...

    • Swagger UI

      Tutte le api possono esser "provate" utilizzando l'interfaccia Swagger a questo indirizzo: https://api.stimatrixcity.it Nel campo "api_key" andrà inserita una chiave api generata tramite il vostro pannello.

    • Coordinate da catasto

      Il servizio consente di recuperare le coordinate a partire dai dati catastali di un immobile. Bounging box + centroide Il sistema, partendo dai dati catastali forniti dal cliente, recupera il bounding box (un rettangolo che racchiude i confini della ...

    • Funzionamento chiamate asincrone

      Cosa significa “asincrone” Alcuni servizi vengono offerti in modalità asincrona ovvero non restituiscono subito il dato richiesto ma lo restituiscono in un secondo tempo. Per quale motivo ci sono chiamate asincrone Le risorse a cui le chiamate ...

    • Crea il tuo primo ordine

      Introduzione Questa guida rapida ti istruirà velocemente su come creare il tuo primo ordine. La struttura dell'ordine Un ORDINE serve per avviare la richiesta di una o più perizie. L' ordine fa riferimento a un CLIENTE di cui andrà creata ...