ScreenScraper WebAPI v2 Documentation#

Qu’est-ce qu’un « Thread » ?#

Certains logiciels de scrape, comme « Universal XML Scraper » vous permette de gagner du ‘temps de scrape’ en ne traitant pas les roms une par une, mais simultanément en parallèle.

Le nombre de scrape simultané est ce que l’on appelle un « Thread ».

Donc avec 4 Threads, vous scrapez vos roms 4 par 4, ce qui représente un gain de temps énorme.

Par contre, cela sollicite beaucoup plus votre ordinateur et votre bande passante (il faut donc que celui-ci ai les ressources nécessaires) mais surtout, sollicite beaucoup plus la base de données et le serveur qui l’héberge.

C’est pour cela que le système de « récompense » a été mis en place. Pour vous remercier de contribuer à la vie de la base de données Screenscraper on vous offre la possibilité de puiser dans ses ressources plus efficacement.

Comment gagner des « Threads » ?#

Il existe 2 méthodes simples :

• Participer à la base de données en proposant de nouvelles informations ou de nouveaux medias
• Participer financièrement à l’hébergement de la base de données via Tipee ou Patreon.

Combien puis-je gagner de « Threads » ?#

Consulter la F.A.Q pour plus d’informations.

Paramètres d’entrées#

• devid : votre identifiant développeur
• devpassword : votre mot de passe développeur
• softname : nom du logiciel appelant
• output : xml(par defaut),json

Elements Retournés#

Item : serveurs (informations serveurs ScreenScraper)

• cpu1 : % d’utilisation du CPU du serveur 1 (moyenne des 5 dernières minutes)
• cpu2 : % d’utilisation du CPU du serveur 2 (moyenne des 5 dernières minutes)
• cpu3 : % d’utilisation du CPU du serveur 3 (moyenne des 5 dernières minutes)
• threadsmin : Nombre d’accés a l’api depuis la dernière minute
• nbscrapeurs : Nombre de scrapeurs utilisant l’api depuis la dernière minute
• apiacces : Nombre d’accés a l’api dans la journée en cours (GMT+1)

Status

• closefornomember : API fermée pour les anonymes (0 : ouvert / 1 : fermé)
• closeforleecher : API fermée pour les membres non participant (0 : ouvert / 1 : fermé)

Quota

• maxthreadfornonmember : Nombre maximum de threads ouverts pour les anonymes
• threadfornonmember : Nombre actuel de threads ouverts par les anonymes
• maxthreadformember : Nombre maximum de threads ouverts pour les membres
• threadformember : Nombre actuel de threads ouverts par les membres

Exemple d’appel#

1
https://api.screenscraper.fr/api2/ssinfraInfos.php?devid=xxx&devpassword=yyy&softname=zzz&output=xml

Paramètres d’entrées#

• devid : votre identifiant développeur
• devpassword : votre mot de passe développeur
• softname : nom du logiciel appelant
• output : xml(par defaut),json
• ssid : identifiant ScreenScraper de l’utilisateur
• sspassword : Mot de passe ScreenScraper de l’utilisateur

Elements Retournés#

Item : ssuser (informations utilisateurs ScreenScraper)

• id : pseudo de l’utilisateur sur ScreenScraper
• numid : identifiant numérique de l’utilisateur
• niveau : niveau de l’utilisateur
• contribution : niveau de contribution financière (2 = 1 Thread Supplémentaire / 3 et + = 5 Threads Supplémentaires)
• uploadsysteme : Compteur de contributions valides (média de système)
• uploadinfos : Compteur de contributions valides (infos texte)
• romasso : Compteur de contributions valides (association de rom)
• uploadmedia : Compteur de contributions valides (média de jeu)
• propositionok : Nombre de propositions validées par un modérateur
• propositionko : Nombre de propositions refusées par un modérateur
• quotarefu : Pourcentage de refu de proposition

Threads

• maxthreads : Nombre de threads autorisés
• maxdownloadspeed : Vitesse de téléchargement (en Ko/s) autorisée

Quotas

• requeststoday : Nombre d’appel total a l’api pendant la journée
• requestskotoday : Nombre d’appel avec retour négatif
• maxrequestspermin : Nombre d’appel maximum autorisé par minute
• maxrequestsperday : Nombre d’appel maximum autorisé par jour
• maxrequestskoperday : Nombre d’appel avec retour négatif maximum autorisé par jour
• visites : nombre de visites
• datedernierevisite : date de la dernière visite (format : yyyy-mm-jj hh:mm)
• favregion : région favorite (france,europe,usa,japon)

Exemple d’appel#

1
https://api.screenscraper.fr/api2/ssuserInfos.php?devid=xxx&devpassword=yyy&softname=zzz&output=xml&ssid=&sspassword=

Paramètres d’entrées#

• devid : votre identifiant développeur
• devpassword : votre mot de passe développeur
• softname : nom du logiciel appelant
• output : xml(par defaut),json
• ssid (non obligatoire) : identifiant ScreenScraper de l’utilisateur
• sspassword (non obligatoire) : Mot de passe ScreenScraper de l’utilisateur

Elements Retournés#

Items : systeme (xml) / systemes (json)

• id : identifiant numérique du système
• parentid : identifiant numérique du système parent
• noms : Noms du système par région
• extensions : extensions des fichiers de roms utilisables
• compagnie : Nom de la société de production
• type : Type de système (Arcade,Console,Console Portable,Emulation Arcade,Flipper,Online,Ordinateur,Smartphone)
• datedebut : Année de début de production
• datefin : Année de fin de production
• romtype : Type(s) de roms
• supporttype : Type du ou des supports d’origines
• medias : Médias du système (logos, wheels, photos, vidéos, bezels, backgrounds, etc.)

Exemple d’appel#

1
https://api.screenscraper.fr/api2/systemesListe.php?devid=xxx&devpassword=yyy&softname=zzz&output=XML&ssid=test&sspassword=test

Paramètres d’entrées#

• devid : votre identifiant développeur
• devpassword : votre mot de passe développeur
• softname : nom du logiciel appelant
• output : xml(par defaut),json
• ssid (non obligatoire) : identifiant ScreenScraper de l’utilisateur
• sspassword (non obligatoire) : Mot de passe ScreenScraper de l’utilisateur
• crc : calcul crc du fichier rom/iso/dossier
• md5 : calcul md5 du fichier rom/iso/dossier
• sha1 : calcul sha1 du fichier rom/iso/dossier
• systemeid : identifiant numérique du système
• romtype : Type de “rom” : fichier rom unique / fichier iso unique / dossier
• romnom : nom du fichier (avec extension) ou nom du dossier
• romtaille : Taille en octet du fichier ou du dossier
• serialnum : Forcer la recherche avec le numero de série
• gameid : Forcer la recherche avec l’identifiant numérique du jeu

Elements Retournés#

Item : jeu

• id : identifiant numérique du jeu
• romid : identifiant numérique de la rom
• notgame : (true/false) indique si la rom est assignée a un NON jeu
• nom : Nom du jeu
• noms : Noms du jeu par région
• cloneof : ID du Clone
• systeme : Informations sur le système
• editeur : Nom de l’éditeur
• developpeur : Nom du développeur
• joueurs : Nombre de joueurs
• note : Note sur 20
• synopsis : Description du jeu par langue
• classifications : Classifications du jeu
• dates : Dates de sortie par région
• genres : Genres du jeu
• modes : Modes de jeu
• familles : Familles du jeu
• themes : Thèmes du jeu
• styles : Styles du jeu
• medias : Médias du jeu (screenshots, fanarts, vidéos, wheels, boitiers, supports, flyers, manuels, bezels)
• roms : Liste des roms connues

Exemple d’appel#

1
https://api.screenscraper.fr/api2/jeuInfos.php?devid=xxx&devpassword=yyy&softname=zzz&output=xml&ssid=test&sspassword=test&crc=50ABC90A&systemeid=1&romtype=rom&romnom=Sonic%20The%20Hedgehog%202%20(World).zip&romtaille=749652

Paramètres d’entrées#

• devid : votre identifiant développeur
• devpassword : votre mot de passe développeur
• softname : nom du logiciel appelant
• output : xml(par defaut),json
• ssid (non obligatoire) : identifiant ScreenScraper de l’utilisateur
• sspassword (non obligatoire) : Mot de passe ScreenScraper de l’utilisateur
• systemeid (non obligatoire) : identifiant numérique du système
• recherche : nom du jeu recherché

Exemple d’appel#

1
https://api.screenscraper.fr/api2/jeuRecherche.php?devid=xxx&devpassword=yyy&softname=zzz&output=xml&ssid=test&sspassword=test&systemeid=1&recherche=sonic

Paramètres d’entrées#

• devid : votre identifiant développeur
• devpassword : votre mot de passe développeur
• softname : nom du logiciel appelant
• ssid (non obligatoire) : identifiant ScreenScraper de l’utilisateur
• sspassword (non obligatoire) : Mot de passe ScreenScraper de l’utilisateur
• crc : calcul crc de l’image existante en local
• md5 : calcul md5 de l’image existante en local
• sha1 : calcul sha1 de l’image existante en local
• systemeid : identifiant numérique du système
• jeuid : identifiant numérique du jeu
• media : identifiant texte du média à retourner

Paramètres de sortie#

• maxwidth (non obligatoire) : Largeur Maximum en pixels
• maxheight (non obligatoire) : Hauteur Maximum en pixels
• outputformat (non obligatoire) : Format de l’image : png ou jpg

Element Retourné#

• Image PNG
• ou Texte CRCOK / MD5OK / SHA1OK si identique au serveur
• ou Texte NOMEDIA si non trouvé

Exemple d’appel#

1
https://api.screenscraper.fr/api2/mediaJeu.php?devid=xxx&devpassword=yyy&softname=zzz&ssid=test&sspassword=test&crc=&md5=&sha1=&systemeid=1&jeuid=3&media=wheel-hd(wor)