Documentazione - Intro

Referenze

Benvenuto nella documentazione per l'integrazione di Link in sistemi esterni tramite HTTPS/REST API! Tutto ciò di cui hai bisogno per inviare le tue richieste.

Base URL

https://api.marcocusano.dev/endpoints

Versioni

Miglioreremo costantemente i servizi offerti e questo include tutti gli strumenti per Sviluppatori. Aggiorneremo costantemente anche i nostri endpoints, per questo elencheremo di seguito una lista di versioni disponibili. Alcune versioni potrebbero non essere visibili o riservate a Clienti con abbonamenti particolari.

VERSIONE	STATO
1	Disponibile

Ogni richiesta dovrà necessariamente contenere la versione a cui si intende fare riferimento, ad esempio:

https://api.marcocusano.dev/endpoints/v{version}

Risposte

Tutte le risposte saranno fornite in JSON, seguendo uno standard semplificato che aiuterà lo sviluppatore a comprendere se la richiesta è stata eseguita correttamente oppure presenta degli errori. Sarà, quindi sempre presente la chiave status a cui seguiranno le chiavi code, message ed error: true solo in caso di errore.

CODICE	ERRORE	MESSAGGIO
1000	Si	API Token in attivazione.
1001	Si	API Token convalidato e abilitato dall'applicazione.
1002	Si	API Token disabilitato dall'applicazione.
1003	Si	API Token rifiutato.
1004	Si	API Token non trovato.
1200	No	Richiesta eseguita correttamente.
1201	No	Richiesta eseguita correttamente, con 0 risultati.
1203	Si	Azione negata.
1204	Si	Azione non trovata.
1205	Si	Parametri mancanti o non validi.
1299	Si	Limite richieste raggiunto.
1403	Si	Accesso al modulo negato.
1404	Si	Modulo non trovato.

La documentazione potrebbe non essere aggiornata contemporaneamente agli endpoints, per questo è disponibile una lista di tutte le risposte fornite direttamente tramite il file responses.json.

Di seguito un esempio di risposta fornita dal server, in caso di errore:

    
        {
            "status" : {
                "code" : 1403,
                "error" : true,
                "message" : "Accesso al modulo negato."
            }
        }

Di seguito un esempio di risposta fornita dal server, senza alcun errore:

    
        {
            "status" : {
                "code" : 200,
                "message" : "Richiesta eseguita correttamente."
            }
        }