Requêtes de catalogue externes

Vous pouvez rechercher les contenus de Roblox en dehors de Studio en accédant à l'API du catalogue externe. Utilisez l'API du Marketplace des créateurs pour interroger les contenus Studio, tels que les maillages, les modèles et l'audio, et le 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 du Marketplace des créateurs

Vous pouvez interroger les articles du catalogue du Marketplace des créateurs à l'aide de l'URL suivante : https://search.roblox.com/catalog/json?[params]

Vous pouvez remplacer [params] avec 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, chacune séparée par un &.

Utilisez les paramètres suivants pour interroger le catalogue du Marketplace des créateurs :

L'URL suivante cherchera 10 éléments dans la sous-catégorie "Modèles", triés par les dernières mises à jour.

https://search.roblox.com/catalog/json?Category=6&SortType=3&ResultsPerPage=10

Champs de réponse

Les réponses de l'API sont renvoyées au format JSON. La réponse fournit les détails de l'actif avec les champs primaires suivants :

Ce qui suit est un exemple de sortie de retour attendue pour un seul élément :

{
    "AssetId": 3374795585,
    "Name": "Rat",
    "Description": "",
    "AbsoluteUrl": "https://www.roblox.com/catalog/3374795585/Rat",
    "Price": "",
    "Updated": "8 months ago",
    "Favorited": "80 times",
    "Sales": "1,613",
    "Remaining": "",
    "Creator": "ROBLOX",
    "CreatorAbsoluteUrl": "https://www.roblox.com/users/1/profile",
    "PrivateSales": "",
    "PriceView": 0,
    "BestPrice": "",
    "ContentRatingTypeID": 0,
    "IsServerSideThumbnailLookupInCatalogEnabled": true,
    "AudioUrl": null,
    "IsLargeItem": false,
    "IsThumbnailFinal": true,
    "IsThumbnailUnapproved": false,
    "ThumbnailUrl": "https://t1.rbxcdn.com/745a4be8c2366db2e55d0a67678434dc",
    "BcOverlayUrl": null,
    "LimitedOverlayUrl": null,
    "DeadlineOverlayUrl": null,
    "LimitedAltText": null,
    "NewOverlayUrl": null,
    "SaleOverlayUrl": null,
    "IosOverlayUrl": null,
    "XboxOverlayUrl": null,
    "GooglePlayOverlayUrl": null,
    "AmazonOverlayUrl": null,
    "IsTransparentBackground": false,
    "IsNewRobuxIconEnabled": true,
    "AssetTypeID": 10,
    "CreatorID": 1,
    "CreatedDate": "/Date(1561635090927)/",
    "UpdatedDate": "/Date(1562003916210)/",
    "IsForSale": false,
    "IsPublicDomain": true,
    "IsLimited": false,
    "IsLimitedUnique": false,
    "MinimumMembershipLevel": 0,
    "OffSaleDeadline": null,
    "ProductId": 586905093
}

API Marketplace

Vous pouvez demander des items d'avatar sur le Marketplace en utilisant l'URL suivante : https://catalog.roblox.com/v2/search/items/details?[params]

Vous pouvez remplacer [params] avec 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, chacune séparée par un &.

Utilisez les paramètres suivants pour interroger le Marketplace :

L'URL suivante va rechercher les 10 premiers items "Équipement" triés par chaque fois ("TriAggrégation") et la pertinence ("TrierType") créés par Roblox ("CreateurCibleID") :

https://catalog.roblox.com/v2/search/items/details?Subcategory=5&CreatorTargetId=1&SortType=0&SortAggregation=5&Limit=10

Champs de réponse

Les réponses de l'API sont renvoyées au format JSON. La réponse fournit des détails sur l'item dans la clé data à l'aide des champs suivants :

Ce qui suit est un exemple de sortie de retour attendue pour un seul élément :

{
    "motClé": null,
    "curseurPagePrécédente": null,
    "curseurPageSuivante": "2_1_c541d05046b5c1c78a5d386b5e302243",
    "data": [
    {
        "id":527373900,
        "itemType":
        "Contenu",
        "contenuType":42,
        "nom":"Bandana des âmes agitées",
        "description":"Ce bandana ne t'aidera pas à te fondre dans la masse des fantômes, mais au moins tu auras du style..",
        "produitId":41270974,
        "genres":[
          "Effrayant",
          "Aventure"
          ],
        "itemStatut":[],
        "itemRestrictions":[],
        "createurType":"Utilisateur",
        "createurCibleId":1,
        "createurNom":"Roblox",
        "prix":300,
        "favoriCompte":15943,
        "HorsVenteDeadline":null
        }
    ]
}