Vous pouvez rechercher des actifs de Roblox en dehors de Studio en accédant à l'API de la boutique des créateurs. Utilisez l'API de la boutique des créateurs pour interroger les actifs de Studio, tels que les maillages, modèles et audio, et l'API du marché pour interroger les actifs d'avatar sur le marché.
Chaque API nécessite une URL et des paramètres de recherche personnalisés pour ce catalogue spécifique. Si l'URL et les paramètres sont valides, l'API renvoie un format JSON avec les résultats de votre recherche.
API de la boutique des créateurs
Pour des informations sur l'appel à l'API de la boutique des créateurs pour la recherche, consultez le service Toolbox dans la référence Open Cloud.
API du marché
Vous pouvez interroger des éléments d'avatar depuis le marché en utilisant l'URL suivante : https://catalog.roblox.com/v1/search/items/details?[params]
Vous pouvez remplacer [params] par les paramètres de requête appropriés pour personnaliser votre recherche.
Paramètres de requête
Vous pouvez spécifier des paramètres de recherche en ajoutant une série de paramètres et de valeurs à l'URL, chacun étant séparé par un &.
Utilisez les paramètres suivants pour interroger le marché :
| Paramètre | Type | Options et Valeurs |
|---|---|---|
| Catégorie | byte | 0 = En vedette 1 = Tout 2 = Objets de collection 3 = Vêtements 4 = Parties du corps 5 = Équipement 11 = Accessoires 12 = Animations d'avatar 13 = Créations de la communauté |
| TypeDeCréateur | byte | 1 = Utilisateur 2 = Groupe Les requêtes utilisant TypeDeCréateur nécessitent également le paramètre IdCibleCréateur. |
| IdCibleCréateur | long | L'ID de l'utilisateur ou du groupe en fonction du TypeDeCréateur fourni. Les requêtes utilisant IdCibleCréateur nécessitent également le paramètre TypeDeCréateur. |
| NomCréateur | string | Recherche par nom de créateur. Si Enum.TypeDeCréateur n'est pas fourni, la recherche concerne uniquement les utilisateurs. |
| Curseur | string | Chaque réponse de recherche contient un nextPageCursor s'il y a une page suivante et un previousPageCursor s'il y a une page précédente. Passez l'un de ces valeurs dans le paramètre Curseur de votre prochaine requête pour obtenir la page suivante ou précédente des résultats. Le curseur est valide si les autres paramètres de requête demeurent les mêmes. |
| Genres | byte | Spécifie le genre pour la recherche. L'approche recommandée pour filtrer par genres est de correspondre à l'URL d'une page de catalogue. 1 = TownAndCity 2 = Médiéval 3 = SciFi 4 = Combat 5 = Horreur 6 = Naval 7 = Aventure 8 = Sports 9 = Comédie 10 = Western 11 = Militaire 13 = Construction 14 = FPS 15 = RPG |
| MotClé | string | Recherche par mot-clé standard. |
| Limite | int | Nombre de résultats à retourner. Les valeurs sont actuellement limitées à 10, 28 et 30. |
| PrixMax | int | Le prix maximum en Robux des articles dans la requête. |
| PrixMin | int | Le prix minimum en Robux des articles dans la requête. |
| TriAggregation | byte | 1 = JourPrécédent 3 = SemainePrécédente 4 = MoisPrécédent 5 = ToutLeTemps |
| TriType | byte | 0 = Pertinence (par défaut) 1 = Ajouté aux Favoris 2 = Ventes 3 = Mis à jour 4 = PrixCroissant 5 = PrixDescendant |
| SousCatégorie | byte | 0 = En vedette 1 = Tout 2 = Objets de collection 3 = Vêtements 4 = Parties du corps 5 = Équipement 9 = Chapeaux 10 = Visages 12 = Chemises 13 = T-shirts 14 = Pantalons 15 = Têtes 19 = Accessoires 20 = Accessoires de cheveux 21 = Accessoires de visage 22 = Accessoires de cou 23 = Accessoires d'épaule 24 = Accessoires avant 25 = Accessoires de dos 26 = Accessoires de taille 27 = Animations d'avatar 37 = Ensembles 38 = Ensembles d'animations 39 = Animations d'émotion 40 = Créations de la communauté 41 = Mêlée 42 = À distance 43 = Explosif 44 = Amélioration 45 = Navigation 46 = Musical 47 = Social 48 = Construction 49 = Transport 54 = Accessoires de tête 55 = T-shirts classiques 56 = Chemises classiques 57 = Pantalons classiques 58 = Accessoires de T-shirt 59 = Accessoires de chemise 60 = Accessoires de pantalon 61 = Accessoires de veste 62 = Accessoires de pull 63 = Accessoires de shorts 64 = Ensembles de chaussures 65 = Accessoires de jupe de robe 66 = Têtes dynamiques |
L'URL suivante recherchera les 10 premiers articles "Équipement" dans "Accessoires" triés par tout le temps ("TriAggregation") et pertinence ("TriType") créés par Roblox ("IdCibleCréateur" et "TypeDeCréateur") :
https://catalog.roblox.com/v1/search/items/details?Category=11&Subcategory=5&CreatorTargetId=1&CreatorType=User&SortType=0&SortAggregation=5&Limit=10
Champs de réponse
Les réponses de l'API renvoient en format JSON. La réponse fournit les détails des actifs dans la clé data en utilisant les champs suivants :
| Champ | Description |
|---|---|
| typeActif | Un des valeurs de type d'actif suivants (retourné uniquement si l'article est un actif). 2 = T-shirt 8 = Chapeau 11 = Chemise 12 = Pantalon 17 = Tête 18 = Visage 19 = Équipement 25 = Bras 26 = Jambes 27 = Torse 28 = BrasDroit 29 = BrasGauche 30 = JambeGauche 31 = JambeDroite 41 = AccessoireDeCheveux 42 = AccessoireDeVisage 43 = AccessoireDeCou 44 = AccessoireDÉpaule 45 = AccessoireAvant 46 = AccessoireDeDos 47 = AccessoireDeTaille 48 = AnimationDeGrimper 49 = AnimationDeMort 50 = AnimationDeChute 51 = AnimationD'Inactivité 52 = AnimationDeSaut 53 = AnimationDeCourse 54 = AnimationDeNatation 55 = AnimationDeMarche 56 = AnimationDePose 61 = AnimationD'Émotion |
| typeEnsemble | L'ID de type d'ensemble (retourné uniquement si l'article est un ensemble). Les valeurs possibles sont PartiesDuCorps et AnimationsD'Avatar. |
| nomCréateur | Le nom du créateur. |
| idCibleCréateur | L'ID du créateur. |
| typeCréateur | Le type de créateur de l'article. |
| description | La description de l'article. |
| nombreFavoris | Le nombre de favoris d'un article. |
| genres | Liste des genres de l'article. Les valeurs possibles comprennent Tout, Tutoriel, Effrayant, TownAndCity, Guerre, Drôle, Fantaisie, Aventure, SciFi, Pirate, FPS, RPG, Sports, Ninja, et FarWest. |
| id | L'ID de l'article. |
| restrictionsArticle | Liste des restrictions de l'article. Les valeurs possibles comprennent TreizePlus, LimitéUnique, Limité, et Rthro. |
| statutArticle | Liste des indicateurs de statut de l'article. Les valeurs possibles comprennent Nouveau, Vente, ExclusifXbox, ExclusifAmazon, ExclusifGooglePlay, ExclusifIos, et SaleTimer. |
| typeArticle | Le type d'article. Les valeurs possibles sont Actif ou Ensemble. |
| prixLePlusBas | Le prix de revente le plus bas de l'article (retourné uniquement si l'article est revendable). |
| nom | Le nom de l'article. |
| prix | Le prix de mise en vente de l'article (le prix actuel peut différer si l'article est revendable). |
| statutPrix | Le statut de prix d'un article qui n'est pas en vente. Les valeurs possibles sont Gratuit, HorsVente, ou PasDeRevendeurs. |
| compteAchats | Le nombre d'achats d'un article. |
| unitésDisponiblesPourConsommation | La quantité disponible pour consommation d'un article unique limité. |
Ce qui suit est un exemple de sortie attendue pour un seul article :
{
"motClé": null,
"curseurPagePrécédente": null,
"curseurPageSuivante": "2_1_c541d05046b5c1c78a5d386b5e302243",
"data": [
{
"id":527373900,
"typeArticle":
"Actif",
"typeActif":42,
"nom":"Bandana des Âmes Tourmentées",
"description":"Ce bandana ne vous aidera pas à vous fondre dans la masse des fantômes, mais au moins vous aurez du style.",
"idProduit":41270974,
"genres":[
"Effrayant",
"Aventure"
],
"statutArticle":[],
"restrictionsArticle":[],
"typeCréateur":"Utilisateur",
"idCibleCréateur":1,
"nomCréateur":"Roblox",
"prix":300,
"nombreFavoris":15943,
"dateLimiteHorsVente":null
}
]
}