AuraX Studios API Documentazione

Questa pagina raccoglie le API di AuraX Studios.

Attenzione!

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

Formato richiesta

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

L'autenticazione avviene tramire l'header Authorization nel seguente formato: Authorization: Bearer <TOKEN>

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;

Sono supportati 3 metodi per passare i parametri nelle richieste:

  • URL query string
  • application/x-www-form-urlencoded
  • application/json

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

Formato risposta

Le API di AuraX Studios rispondono in formato JSON con oggetti primitivi o con oggetti elencati in fondo alla pagina.

Tipi di errore

Verrà restituito un oggetto di tipo GenericResponse con uno delle seguenti configurazioni:

Generici

code message
NOT_FOUND Not found
TOO_MANY_REQUESTS The request cannot be served due to the rate limit having been exhausted for the resource
UNAUTHORIZED You not have the necessary credentials
UNPROCESSABLE_ENTITY Messaggio dinamico
SERVER_ERROR Server error. Contact an administrator

Specifici

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

API

Taboo

TotalCards

Ottiene il numero totale di tutte le carte

GET v2/taboo/total-cards

Limite richieste   60 richieste  ogni  minuto

Inline

Nessun elemento inline da visualizzare.

Input

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

Output

Restituisce un oggetto di tipo int

Cards

Ottiene la lista di tutte le carte

GET v2/taboo/cards

Limite richieste   60 richieste  ogni  minuto

Inline

Nessun elemento inline da visualizzare.

Input

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

Output

Restituisce un array di tipo TabooCard

Card

Ottiene una carta tramite il suo ID

GET v2/taboo/card/{id}

Limite richieste   60 richieste  ogni  minuto

Inline

Nome Tipo Richiesto Default Descrizione
id int Codice carta

Input

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

Output

Restituisce un oggetto di tipo TabooCard

SuggestCard

Suggerisce una nuova carta

POST v2/taboo/suggest-card

Limite richieste   10 richieste  ogni  minuto

Inline

Nessun elemento inline da visualizzare.

Input

Nome Tipo Richiesto Default Descrizione
lang string Codice lingua. Codici disponibili: it, en
guess_word string Parola principale da indovinare
taboo_word_1 string Parola taboo 1
taboo_word_2 string Parola taboo 2
taboo_word_3 string Parola taboo 3
taboo_word_4 string Parola taboo 4
taboo_word_5 string Parola taboo 5

Output

Restituisce un oggetto di tipo GenericResponse

Spread

Spread

Ottiene lo spread di tutti i paesi europei

GET v2/spread

Limite richieste   60 richieste  ogni  minuto

Inline

Nessun elemento inline da visualizzare.

Input

Nessun elemento inline da visualizzare.

Output

Restituisce un oggetto di tipo Spread

Facebook

LastPhoto

Otteniene l'ultima foto di un album

GET v2/facebook/last-photo/{id}

Limite richieste   1 richiesta  ogni  5 minuti

Inline

Nome Tipo Richiesto Default Descrizione
id int ID di un album pubblico

Input

Nessun elemento inline da visualizzare.

Output

Restituisce un oggetto di tipo FacebookPhoto

Humble Bundle

Blog

Ottiene il feed del blog

GET v2/humble-bundle/blog

Limite richieste   40 richieste  ogni  minuto

Inline

Nessun elemento inline da visualizzare.

Input

Nessun elemento inline da visualizzare.

Output

Restituisce un array di tipo BlogItem

ActiveBundles

Ottiene tutti i bundle attivi

GET v2/humble-bundle/active-bundles

Limite richieste   60 richieste  ogni  minuto

Inline

Nessun elemento inline da visualizzare.

Input

Nessun elemento inline da visualizzare.

Output

Restituisce un array di tipo ActiveBundle

FreeProducts

Ottengo tutti i prodotti gratuiti sullo store

GET v2/humble-bundle/free-products

Limite richieste   60 richieste  ogni  minuto

Inline

Nessun elemento inline da visualizzare.

Input

Nessun elemento inline da visualizzare.

Output

Restituisce un array di tipo FreeBundleProduct

BundleInfo

Ottengo le info del bundle

GET v2/humble-bundle/bundle-info

Limite richieste   20 richieste  ogni  minuto

Inline

Nessun elemento inline da visualizzare.

Input

Nome Tipo Richiesto Default Descrizione
url string Url del bundle

Output

Restituisce un oggetto di tipo BundleInfo

Twitter

Tweets

Ottiene gli ultimi tweet di un account

GET v2/twitter/tweets/{account}

Limite richieste   10 richieste  ogni  minuto

Inline

Nome Tipo Richiesto Default Descrizione
account string Username account

Input

Nessun elemento inline da visualizzare.

Output

Restituisce un array di tipo Tweet

Tweet

Ottiene le info di un tweet

GET v2/twitter/tweet/{id}

Limite richieste   10 richieste  ogni  minuto

Inline

Nome Tipo Richiesto Default Descrizione
id int Id di un tweet

Input

Nessun elemento inline da visualizzare.

Output

Restituisce un oggetto di tipo Tweet

YouTube

ChannelInfo

Ottiene le info di un canale

GET v2/youtube/channel-info/{username}

Limite richieste   10 richieste  ogni  minuto

Inline

Nome Tipo Richiesto Default Descrizione
username string Username account

Input

Nessun elemento inline da visualizzare.

Output

Restituisce un oggetto di tipo YouTubeInfo

ChannelVideos

Ottiene gli ultimi video di un canale

GET v2/youtube/channel-videos/{username}

Limite richieste   10 richieste  ogni  minuto

Inline

Nome Tipo Richiesto Default Descrizione
username string Username account

Input

Nome Tipo Richiesto Default Descrizione
order string date Tipo di ordinamento. Ordinamenti disponibili: date, rating, relevance, title, videoCount, viewCount
limit int 20 Numero di elementi per pagina
page_token string null Token pagina

Output

Restituisce un oggetto di tipo YouTubeList

ChannelPlaylists

Ottiene le playlist di un canale

GET v2/youtube/channel-playlists/{username}

Limite richieste   10 richieste  ogni  minuto

Inline

Nome Tipo Richiesto Default Descrizione
username string Username account

Input

Nessun elemento inline da visualizzare.

Output

Restituisce un array di tipo YouTubePlaylist

PlaylistVideos

Ottiene gli ultimi video di una playlist

GET v2/youtube/playlist-videos/{playlistID}

Limite richieste   10 richieste  ogni  minuto

Inline

Nome Tipo Richiesto Default Descrizione
playlistID string ID di una playlist

Input

Nome Tipo Richiesto Default Descrizione
order string date Tipo di ordinamento. Ordinamenti disponibili: date, rating, relevance, title, videoCount, viewCount
limit int 20 Numero di elementi per pagina
page_token string null Token pagina

Output

Restituisce un oggetto di tipo YouTubeList

Minecraft

ServiceStatuses

Ottiene lo stato dei servizi collegati a minecraft

GET v2/minecraft/service-statuses

Limite richieste   60 richieste  ogni  minuto

Inline

Nessun elemento inline da visualizzare.

Input

Nessun elemento inline da visualizzare.

Output

Restituisce un array di tipo MinecraftService

OGGETTI

Nome Tipo Descrizione
code string Codice del messaggio
message string Messaggio
Nome Tipo Descrizione
id int ID della carta
guess_word string Parola principale da indovinare
taboo_word_1 string Parola taboo 1
taboo_word_2 string Parola taboo 2
taboo_word_3 string Parola taboo 3
taboo_word_4 string Parola taboo 4
taboo_word_5 string Parola taboo 5
Nome Tipo Descrizione
snapshot_time int Timestamp ultimo aggiornamento
countries SpreadCountries Lista degli spread per nazione
Nome Tipo Descrizione
germany SpreadCountry Spread Germania
france SpreadCountry Spread Francia
belgium SpreadCountry Spread Belgio
italy SpreadCountry Spread Italia
spain SpreadCountry Spread Spagna
denmark SpreadCountry Spread Danimarca
finland SpreadCountry Spread Finlandia
netherlands SpreadCountry Spread Paesi Bassi
austria SpreadCountry Spread Austria
czech SpreadCountry Spread Repubblica Ceca
ireland SpreadCountry Spread Irlanda
slovenia SpreadCountry Spread Slovenia
hungary SpreadCountry Spread Ungheria
portugal SpreadCountry Spread Portogallo
slovakia SpreadCountry Spread Slovacchia
Nome Tipo Descrizione
yield string Campo yield
spread string Campo spread
close string Campo close
change string Campo change
Nome Tipo Descrizione
id int ID della foto
date int Timestamp creazione foto
text string Descrizione foto
photo string Url diretto della foto
link string Url della foto da facebook
Nome Tipo Descrizione
title string Titolo dell'articolo
description string Breve contenuto dell'articolo
content string Contenuto dell'articolo
date int Data dell'articolo (timestamp)
url string Link articolo
Nome Tipo Descrizione
id string ID del bundle
type string Tipo di bundle
title string Titolo del bundle
subtitle string|null Sottotitolo del bundle
description string Descrizione del bundle
url string Url del bundle
start_date int Data di inizio del bundle (timestamp)
end_date int Data di scadenza del bundle (timestamp)
bundles_sold int|null Numero di bundle acquistati
Nome Tipo Descrizione
id string ID del prodotto
title string Titolo del prodotto
image string Url dell'immagine del prodotto
url string Url della pagina del prodotto
expire_at int Timestamp data di scadenza della promozione
Nome Tipo Descrizione
id string ID del bundle
title string Titolo del bundle
subtitle string|null Sottotitolo del bundle
image string Url dell'immagine del bundle
type string Tipo di bundle
url string Url del bundle
descriptions Array di string Descrizione del bundle
warnings Array di string Warning del bundle
time_left int Tempo rimasto al bundle (secondi)
worth string Valore del bundle
sold int Bundle venduti
bundles Array di BundlePack Pacchetto del bundle
Nome Tipo Descrizione
title string Titolo del pacchetto
subtitle string|null Sottotitolo del pacchetto
soldout bool Verifica se un pacchetto è terminato
products Array di BundleProduct Prodotti del pacchetto
Nome Tipo Descrizione
id string ID del prodotto
title string Titolo del prodotto
subtitle string|null Sottotitolo del prodotto
description string Descrizione del prodotto
image string Url dell'immagine del prodotto
deliveries BundleDeliveries Disponibilità del prodotto
platforms BundlePlatforms Distribuzioni del prodotto
Nome Tipo Descrizione
steam bool Disponibilità prodotto steam
key bool Disponibilità prodotto come chiave
android bool Disponibilità prodotto android
psvita bool Disponibilità prodotto psvita
ps3 bool Disponibilità prodotto ps3
ps4 bool Disponibilità prodotto ps4
Nome Tipo Descrizione
windows bool Distribuzione prodotto windows
osx bool Distribuzione prodotto osx
linux bool Distribuzione prodotto linux
Nome Tipo Descrizione
id int ID del tweet
created_at int Data timestamp del tweet
text string Testo del tweet
url string Link del tweet
retweet int Numero di retweet totali
likes int Numero di like totali
is_retweet bool Restituisce TRUE se è un retweet altrimenti FALSE
Nome Tipo Descrizione
id string ID del canale
title string Titolo del canale
description string Descrizione del canale
published_at int Timestamp data di pubblicazione
thumbnail string Url thumbnail canale
banner string Url copertina canale
subscriber_count int Totale iscritti al canale
view_count int Totale visualizzazioni ai video del canale
video_count int Totale video del canale
Nome Tipo Descrizione
items Array di YouTubeVideo Array di video
page_info YouTubePage Informazioni sulla paginazione
Nome Tipo Descrizione
id string ID del video
url string Url del video
title string Titolo del video
description string Descrizione del video
published_at int Timestamp data di pubblicazione del video
thumbnail string Url dell'anteprima del video
Nome Tipo Descrizione
total_results int Totale dei video nella lista
results_per_page int Totale dei video per pagina nella lista
next_page_token string|null Token pagina successiva della lista dei video
prev_page_token string|null Token pagina precedente della lista dei video
Nome Tipo Descrizione
id string ID della playlist
title string Titolo della playlist
published_at int Timestamp data di pubblicazione della playlist
thumbnail string Url dell'anteprima della playlist
Nome Tipo Descrizione
service string Nome del servizio
status string Stato del servizio
message string Messaggio associato allo stato del servizio