AuraX Studios API Documentazione

Questa pagina raccoglie le API di AuraX Studios.

Attenzione!

Al momento non si può richiedere un APIKEY, in quanto l'utilizzo delle API è in fase di BETA privata.

Formato richiesta

Le API di AuraX Studios sono disponibili attraverso HTTPS da api.auraxstudios.com

Queste Web API sono divise in Interfacce con i relativi metodi.

La richiesta ad una specifica API può essere di 4 tipi:

  • GET per la lettura di dati;
  • POST per l'aggiunta di dati;
  • PUT per l'aggiornamento di dati;
  • DELETE per la cancellazione di dati;

Il formato dell'URI per ogni API è il seguente: https://api.auraxstudios.com/<versione>/<interfaccia>/<metodo>/

Formato risposta

Le API di AuraX Studios rispondono solo nel formato JSON con la seguente struttura:

Nome Tipo Descrizione
status bool Restituisce true se l'operazione si è conclusa con successo altrimenti false.
error object Restituisce null se l'operazione si è conclusa con successo altrimenti object.
output object Restituisce object se l'operazione si è conclusa con successo altrimenti null.

error è composto da:

Nome Tipo Descrizione
code string Restituisce un codice di errore.
message string Restituisce un messaggio di errore.

output è uno specifico output che varia da API ad API, la sua struttura viene mostrata sotto ad ogni API.

Tipi di errore

Generici

code message
REMOVED This api was removed. Use another api.
MAINTENANCE This api is under maintenance. Please retry later.
OFFLINE This api is temporarily unavailable. Please retry later.
APIKEY_NOT_VALID The 'apikey' parameter is not set or valid.

Specifici

Variano da API ad API, una lista di errori specifici viene mostrata sotto ad ogni API.

AuraX Studios

AppList

Ottiene la lista delle app di AuraX Studios.

GET v1/AuraXStudios/AppList/

Inline

Nessun elemento inline da visualizzare.

Input

Nome Tipo Richiesto Default Descrizione
apikey string API Key

Output

Restituisce un array di:

Nome Tipo Descrizione
id int Id dell'app.
names object [ ] Tutti i nomi dell'app.
descriptions object [ ] Tutte le descrizioni dell'app.
version string Versione dell'app.
lastUpdate string Data dell'ultimo aggiornamento dell'app.
supportedOS string [ ] OS supportati dall'app. Supportati: 71, 80, 81, 10
storeLink string Url dell'app.
storeIcon string Url dell'icona dello store dell'app.
guid string Guid dell'app.
category string Tipo applicazione. Supportati: APP, GAME

names restituisce un array di:

Nome Tipo Descrizione
language_code string Codice lingua. Supportati: ISO 639-1, universal
title string Nome dell'app.

descriptions restituisce un array di:

Nome Tipo Descrizione
language_code string Codice lingua. Supportati: ISO 639-1
description string Descrizione dell'app.

Errori

Nessun errore specifico da visualizzare.

CheckVersion

Controlla se c'è un aggiornamento di un'app di AuraX Studios.

GET v1/AuraXStudios/CheckVersion/{appId}/{appVersion}/

Inline

Nome Tipo Richiesto Default Descrizione
appId int Id dell'app.
appVersion string Versione da controllare dell'app nel formato x.x.x.x dove x sta per un numero intero.

Input

Nome Tipo Richiesto Default Descrizione
apikey string API Key

Output

Restituisce:

Nome Tipo Descrizione
id int Id dell'applicazione.
version string Versione corrente dell'applicazione.
checkingVersion string Versione da controllare dell'applicazione.
toUpdate bool Restituisce true se la versione da controllare è più vecchia della versione corrente altrimenti false.

Errori

code message
APPVERSION_NOT_VALID appVersion is not valid
APPID_NOT_FOUND appid not found

Mojang

ServiceStatuses

Ottiene lo stato dei servizi della Mojang.

GET v1/Mojang/ServiceStatuses/

Inline

Nessun elemento inline da visualizzare.

Input

Nome Tipo Richiesto Default Descrizione
apikey string API Key

Output

Restituisce un array di:

Nome Tipo Descrizione
service string Nome del servizio.
status string Stato del servizio. Supportati: green, yellow, red
message string Messaggio di stato del servizio.

Errori

Nessun errore specifico da visualizzare.

QDSS

GetBlogFeed

Ottiene la lista delle ultime notizie del blog di QDSS.

GET v1/QDSS/GetBlogFeed/

Inline

Nessun elemento inline da visualizzare.

Input

Nome Tipo Richiesto Default Descrizione
apikey string API Key

Output

Restituisce un array di:

Nome Tipo Descrizione
title string Titolo del feed.
description string Descrizione del feed.
date int Timestamp UTC del feed.
url string Url del feed.

Errori

Nessun errore specifico da visualizzare.

GetJokes

Ottiene la lista delle barzellette di QDSS.

GET v1/QDSS/GetJokes/

Inline

Nessun elemento inline da visualizzare.

Input

Nome Tipo Richiesto Default Descrizione
apikey string API Key

Output

Restituisce un array di:

Nome Tipo Descrizione
id int Id della barzelletta.
joke string Testo della barzelletta.

Errori

Nessun errore specifico da visualizzare.

AddJoke

Suggerisce un nuova barzelletta da aggiungere alle barzellette di QDSS.

POST v1/QDSS/AddJoke/

Inline

Nessun elemento inline da visualizzare.

Input

Nome Tipo Richiesto Default Descrizione
apikey string API Key
joke string Barzelletta.

Output

Restituisce true se l'operazione è stata completata con successo altrimenti false.

Errori

code message
ERROR_P1 The joke parameter is null or not set.

Taboo

GetCards

Ottiene la lista di tutte le carte Taboo.

GET v1/Taboo/GetCards/{lang}/

Inline

Nome Tipo Richiesto Default Descrizione
lang string Codice lingua. Supportate: it, en

Input

Nome Tipo Richiesto Default Descrizione
apikey string API Key

Output

Restituisce un array di:

Nome Tipo Descrizione
ID string Id della carta.
Key string Parola Chiave.
T1 string Parola Taboo 1.
T2 string Parola Taboo 2.
T3 string Parola Taboo 3.
T4 string Parola Taboo 4.
T5 string Parola Taboo 5.

Errori

Nessun errore specifico da visualizzare.

GetTotalCards

Ottiene il numero totale di tutte le carte Taboo.

GET v1/Taboo/GetTotalCards/{lang}/

Inline

Nome Tipo Richiesto Default Descrizione
lang string Codice lingua. Supportate: it, en

Input

Nome Tipo Richiesto Default Descrizione
apikey string API Key

Output

Restituisce il numero (int) di carte totali.

Errori

Nessun errore specifico da visualizzare.

SuggestCard

Suggerisce una carta da inserire nel database di Taboo.
La carta dovrà essere approvata dallo staff.

POST v1/Taboo/SuggestCard/{lang}/

Inline

Nome Tipo Richiesto Default Descrizione
lang string Codice lingua. Supportate: it, en

Input

Nome Tipo Richiesto Default Descrizione
apikey string API Key
key string Parola Chiave.
word1 string Parola Taboo 1
word2 string Parola Taboo 2
word3 string Parola Taboo 3
word4 string Parola Taboo 4
word5 string Parola Taboo 5

Output

Restituisce true se l'operazione è stata completata con successo altrimenti false.

Errori

code message
KEY_PARAM_NOT_SET The parameter 'key' is not set.
WORD1_PARAM_NOT_SET The parameter 'word1' is not set.
WORD2_PARAM_NOT_SET The parameter 'word2' is not set.
WORD3_PARAM_NOT_SET The parameter 'word3' is not set.
WORD4_PARAM_NOT_SET The parameter 'word4' is not set.
WORD5_PARAM_NOT_SET The parameter 'word5' is not set.

YouTube

GetChannelInfo

Ottiene le info di un canale YouTube.

GET v1/YouTube/GetChannelInfo/{channelName}/

Inline

Nome Tipo Richiesto Default Descrizione
channelName string Nome del canale YouTube.

Input

Nome Tipo Richiesto Default Descrizione
apikey string API Key

Output

Restituisce:

Nome Tipo Descrizione
id string Id del canale
title string Nome del canale
description string Descrizione del canale
publishedAt string Data di iscrizione del canale in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ)
thumbnail string Url del logo del canale
banner string Url del banner del canale
subscriberCount int Numero di iscritti al canale
viewCount int Numero totale di visualizzazioni dei video del canale
videoCount int Numero di video del canale

Errori

code message
CHNL_NOT_FOUND Channel not found.

GetChannelVideos

Ottiene la lista degli ultimi video di un canale YouTube.

GET v1/YouTube/GetChannelVideos/{channelName}/

Inline

Nome Tipo Richiesto Default Descrizione
channelName string Nome del canale YouTube.

Input

Nome Tipo Richiesto Default Descrizione
apikey string API Key
pageToken string null Token della pagina.
limit int 20 Numero di video per pagina.
order string date Modalità di ordinamento. Supportate: date, rating, relevance, title, videoCount, viewCount

Output

Restituisce:

Nome Tipo Descrizione
pageInfo object Info utili alla navigazione tra pagine.
items object [ ] Lista di video.

pageInfo restituisce:

Nome Tipo Descrizione
totalResults int Totale risultati.
resultsPerPage int Risultati per pagina.
nextPageToken string Token per andare avanti di pagina.
prevPageToken string Token per andare indietro di pagina.

items restituisce un array di:

Nome Tipo Descrizione
id string Id del video.
url string Url del video.
title string Titolo del video.
description string Descrizione parziale del video.
date int Data in Timestamp Unix UTC.
thumbnails string Url dell'immagine di anteprima del video.

Errori

code message
ORDER_PARAM_NOT_VALID The parameter 'order' is not valid.
CHL_NOT_FOUND The channel was not found.

GetPlaylists

Ottiene la lista delle ultime 50 playlist di un canale YouTube.

GET v1/YouTube/GetPlaylists/{channelName}/

Inline

Nome Tipo Richiesto Default Descrizione
channelName string Nome del canale YouTube.

Input

Nome Tipo Richiesto Default Descrizione
apikey string API Key

Output

Restituisce un array di:

Nome Tipo Descrizione
id string Id della playlist.
publishedAt string Data di pubblicazione della playlist in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ)
title string Titolo della playlist.
thumbnail string Url dell'immagine di anteprima della playlist.

Errori

code message
CHL_NOT_FOUND The channel was not found.

GetPlaylistVideos

Ottiene la lista di tutti i video di una playlist.

GET v1/YouTube/GetPlaylistVideos/{playlistID}/

Inline

Nome Tipo Richiesto Default Descrizione
playlistID string Id della playlist YouTube.

Input

Nome Tipo Richiesto Default Descrizione
apikey string API Key
maxResults int 20 Numero di video per pagina.
pageToken string null Token della pagina.

Output

Restituisce:

Nome Tipo Descrizione
pageInfo object Info utili alla navigazione tra pagine.
items object [ ] Lista di video.

pageInfo restituisce:

Nome Tipo Descrizione
totalResults int Totale risultati.
resultsPerPage int Risultati per pagina.
nextPageToken string Token per andare avanti di pagina.
prevPageToken string Token per andare indietro di pagina.

items restituisce un array di:

Nome Tipo Descrizione
id string Id del video.
publishedAt string Data di pubblicazione del video in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ)
title string Titolo del video.
description string Descrizione del video.
thumbnails string Url dell'immagine di anteprima del video.
url string Url del video.

Errori

code message
PLAYLIST_NOT_FOUND Playlist not found.

Twitter

GetTweets

Ottiene la lista degli ultimi tweet di un account Twitter.

GET v1/Twitter/GetTweets/{accountName}/[limit]/

Inline

Nome Tipo Richiesto Default Descrizione
accountName string Nome dell'account Twitter.
limit int 20 Numero di tweet.

Input

Nome Tipo Richiesto Default Descrizione
apikey string API Key

Output

Restituisce un array di:

Nome Tipo Descrizione
id string Id del tweet.
date int Data in Timestamp Unix UTC del tweet.
tweet string Testo parziale del tweet.
url string Url del tweet.
retweet int Numero di retweet del tweet.
likes int Numero di Mi Piace del tweet.
isRetweet bool Controlla se il tweet è un retweet.

Errori

code message
ACCOUNT_NOT_FOUND The account entered is not found.

GetTweet

Ottiene un Tweet associato ad un ID.

GET v1/Twitter/GetTweet/{id}/

Inline

Nome Tipo Richiesto Default Descrizione
id int ID del Tweet.

Input

Nome Tipo Richiesto Default Descrizione
apikey string API Key

Output

Restituisce un array di:

Nome Tipo Descrizione
id int Id del tweet.
text string Testo del tweet.
created_at int Data in Timestamp Unix UTC del tweet.

Errori

code message
TWEET_NOT_FOUND No tweet found with that ID.