ForumCommunity

Wiki - API

    Come funziona


    Per accedere alle API è necessaria l'abilitazione.
    Per averla aprire un topic in questa sezione spiegando i motivi per cui si chiede l'abilitazione.

    È disponibile un sistema API ufficiale per permettere agli sviluppatori di interfacciarsi con i dati dei nostri circuiti.

    Documentazione API interattiva (Swagger UI).


    Per accedere ai dati si usa lo script api.php nel seguente modo:

    • ForumFree, dominio.forumfree.it/api.php
    • ForumCommunity, dominio.forumcommunity.net/api.php
    • BlogFree, dominio.blogfree.net/api.php

    I dati vengono restituiti in formato JSON.
    Per proposte e aggiunte alle API utilizzare questo topic.

    Lista delle principali API


    Homepage
    Senza parametri vengono restituiti solo i dati della homepage del dominio specificato.
    Parametro stats=1: vengono restituite solo le statistiche del forum, senza le sezioni
    Esempi:
    https://supporto.forumfree.it/api.php
    https://supporto.forumfree.it/api.php?stats=1

    Sezioni
    Parametro f=XXXXX: dati della sezione con id XXXXX (30 discussioni per pagina)
    Per selezionare le altre pagine si usa il parametro st (st=30, st=60, ecc.).
    Per selezionare l'ultima pagina si imposta il parametro st=last
    Parametro nc=1: ordinamento delle discussioni per data di creazione
    Parametro pinned=0/1/2: seleziona solo le discussioni normali (0), importanti (1) o annunci (2)
    Parametro starter=XXXXX: vengono restituiti gli id delle discussioni create dall'utente con id XXXXX
    Parametro starter=XXXXX&threads=1: vengono restituiti anche i dati delle discussioni (30 alla volta)
    Parametro noinfo=1: vengono restituiti solo gli id e i titoli delle discussioni
    Esempi:
    https://supporto.forumfree.it/api.php?f=194
    https://supporto.forumfree.it/api.php?f=194&st=30
    https://supporto.forumfree.it/api.php?f=194&pinned=1
    https://supporto.forumfree.it/api.php?f=194&starter=4
    https://supporto.forumfree.it/api.php?starter=4 (cerca in tutto il forum)
    https://supporto.forumfree.it/api.php?starter=4&threads=1 (visualizza anche i dati delle discussioni)

    Discussioni
    Parametro t=XXXXX: dati della discussione con id XXXXX (15 messaggi per pagina)
    Per selezionare le altre pagine si usa il parametro st (st=15, st=30, ecc.).
    Per selezionare l'ultima pagina si imposta il parametro st=last
    Per selezionare solo l'ultimo post si imposta il parametro st=lastpost
    Per selezionare solo il primo post si imposta il parametro st=firstpost
    Esempi:
    https://supporto.forumfree.it/api.php?t=1787629
    https://supporto.forumfree.it/api.php?t=1787629&st=15
    https://supporto.forumfree.it/api.php?t=1787629&st=last
    https://supporto.forumfree.it/api.php?t=1787629&st=lastpost

    Ultime discussioni attive
    Parametro a: restituisce le ultime discussioni attive nel sito
    Parametro n=XX: vengono restituite XX discussioni (da 1 a 15)
    Parametro sez (es.: &sez=1,2,3): seleziona solo una o più sezioni
    Parametro nosez (es.: &nosez=1,2,3): esclude una o più sezioni
    Parametro nc=1: ordinamento delle discussioni per data di creazione
    Esempi:
    https://supporto.forumfree.it/api.php?a
    https://supporto.forumfree.it/api.php?a&n=1

    Messaggi
    Parametro p=XXXXX: dati del messaggio con id XXXXX (si possono specificare più messaggi separando diversi id con le virgole: p=3423,345345,345345,...)
    Esempi:
    https://supporto.forumfree.it/api.php?p=19481714
    https://supporto.forumfree.it/api.php?p=51276840,51315074

    Utenti
    Parametro mid=XXXXX: dati dell'utente con id XXXXX (si possono specificare anche più utenti separando diversi id con le virgole: mid=3423,345345,345345,...)
    Parametro nick=XXXXX: dati dell'utente con nickname XXXXX (si possono specificare anche più utenti separando diversi nickname con le virgole: nick=Utente1,Utente2,Utente3,...)
    Parametro detail=1: vengono forniti tutti i dettagli del profilo
    Esempi:
    https://supporto.forumfree.it/api.php?mid=1
    https://supporto.forumfree.it/api.php?nick=Amnesiac
    https://supporto.forumfree.it/api.php?mid=583463,583041
    https://supporto.forumfree.it/api.php?mid=1&detail=1

    Gruppi
    Parametro g=XX: dati del gruppo con id XX (si possono specificare più gruppi separando diversi id con le virgole: g=1,3,8,...).
    È possibile avere l'elenco degli utenti admin,mod o la lista completa specificando "admin","mod" o "members" al posto dell'id del gruppo.
    Per quanto riguarda la lista "members" vengono restituiti 1000 utenti alla volta (per le pagine successive si usa il solito parametro "st": st=1000, st=2000, ecc.).
    Parametro detail=1: oltre agli id degli utenti vengono restituiti anche nickname e avatar. Vengono restituiti 30 utenti per pagina.
    Esempi:
    https://supporto.forumfree.it/api.php?g=1
    https://supporto.forumfree.it/api.php?g=1&detail=1
    https://newsboard.forumcommunity.net/api.php?g=1,admin,mod,2
    https://newsboard.forumfree.it/api.php?g=members

    HTML aggiuntivo
    https://supporto.forumfree.it/api.php?html

    Pagine personalizzate
    Parametro pag=XXX: contenuto della pagina personalizzata XXX

    Logo e titolo
    https://skinlab.forumfree.it/api.php?title

    Emoticons
    https://supporto.forumfree.it/api.php?emoticons

    Autenticazione
    Wiki - API - Autenticazione e contenuti privati

    Notifiche nuovi messaggi
    Se si è autenticati si possono visualizzare eventuali notifiche per nuovi messaggi nelle discussioni seguite oppure nuovi messaggi privati.
    Il parametro da utilizzare è mid=me
    Esempio: https://supporto.forumfree.it/api.php?mid=me&cookie=1

    Lista iscrizioni
    Se si è autenticati si può visualizzare la lista completa delle discussioni a cui si è iscritti.
    Il parametro da utilizzare è tracker
    Esempio: https://supporto.forumfree.it/api.php?tracker&cookie=1

    Elenco votanti in top forum/blog
    Se si è autenticati come amministratori si possono visualizzare l'elenco degli utenti che hanno votato per il proprio forum/blog.
    Il parametro da utilizzare è top
    Esempio: https://supporto.forumfree.it/api.php?top&cookie=1

    Tagboard
    Il parametro da utilizzare è tagboard
    Esempio: https://supporto.forumfree.it/api.php?tagboard
    È possibile avere i dati della tagboard anche direttamente nell'api della homepage o delle sezioni aggiungendo il parametro showtag=1 a tali api
    Esempio: https://supporto.forumfree.it/api.php?f=4&showtag=1
    Esempio: https://ffmagazine.forumfree.it/api.php?showtag=1

    Top Members (classifica per reputazione)
    Il parametro da utilizzare è rep
    Esempio: https://supporto.forumfree.it/api.php?rep