Crear consultas de la tienda

Puede buscar los recursos de Roblox fuera de Studio accediendo a la API de la Tienda del Creador. Usa la API de la Tienda del Creador para consultar los recursos de Studio, como los modelos, los datos y el sonido, audio, y la API del Mercado para consultar los recursos del avatar en el Mercado.

Cada API requiere una URL y parámetros de búsqueda personalizados para ese catálogo específico. Si ambas URL y parámetros son válidos, la API devuelve un formato JSON con los resultados de su buscar.

API de la Tienda del Creador

Puede buscar artículos en el catálogo de la Tienda del Creador usando la siguiente URL: https://apis.roblox.com/toolbox-service/v1/marketplace/{categoryId}[params]

Puede reemplazar [categoryId] y [params] con los parámetros de búsqueda apropiados para personalizar su buscar.

Los ID de categoría válidos son:

• Audio = 3
• Modelo = 10
• Decal = 13
• Animación = 24
• Plugin = 38
• MeshPart = 40
• Video = 62
• FontFamily = 73
• Música = 300

Parámetros de consulta

Puede especificar parámetros de búsqueda agregando una serie de parámetros y valores a la URL, cada uno separado por un & .

Usa los siguientes parámetros para buscar en la Tienda del Creador:

Para obtener más información con respecto a toolbox-service , por favor consulte la documentación actualizada a continuación.

Esta es una respuesta de ejemplo del punto de interfaz:

{
  "totalResults": int,
  "filteredKeyword": string,
  "spellCheckerResult": {
    "correctionState": int,
    "correctedQuery": string,
    "userQuery": string
  },
  "queryFacets": {
    "appliedFacets": Array[string],
    "availableFacets": Array[string]
  },
  "imageSearchStatus": int,
  "previousPageCursor": string,
  "nextPageCursor": string,
  "data": [
    {
      "id": int,
      "name": string,
      "searchResultSource": string
    }
  ]
}

Para recuperar los metadatos del activo, puede ir sobre el conjunto de datos y extraer los ID con el GetItemDetails punto de interfaz en toolbox-service como esto:

GET https://apis.roblox.com/toolbox-service/v1/items/details?assetIds={assetId1}%2C{assetId2}

Campos de respuesta

Esta es la respuesta que deberías esperar para obtener de nuevo desde ese punto de extremo:

{
  "data": [
    {
      "asset": {
        "audioDetails": {
           "audioType": Array[int],
           "artist": string,
           "title": string,
           "musicAlbum": string,
           "musicGenre": string,
           "soundEffectCategory": string,
           "soundEffectSubcategory": string,
           "tags": Array[string] 
        },
        "id": int64,
        "name": string,
        "typeId": int,
        "assetSubTypes": Array[string],
        "assetGenres": Array[string],
        "ageGuidelines":{
          "ageGuideline: int,
          "blood": {
             "realism": int,
             "level": int
           },
          "violence": {
            "intensity": int
           },
          "profanity": {
            "presence": int
           },
          "alcohol": {
            "presence": int
           },
          "romance": {
            "type": int
           }
        },
        "isEndorsed": bool,
        "description": string,
        "duration": int,
        "hasScripts": bool?,
        "createdUtc": string($date-time),
        "updatedUtc": string($date-time),
        "creatingUniverseId": int64?,
        "isAssetHashApproved": bool,
        "visibilityStatus": int?,
        "socialLinks": [{
           "linkType": int,
           "url": string,
           "title": string
        }]
      },
      "creator": {
        "id": int64,
        "name": string,
        "type": int,
        "isVerifiedCreator": bool,
        "latestGroupUpdaterUserId": int64?,
        "latestGroupUpdaterUserName": string
      },
      "voting": {
        "showVotes": bool,
        "upVotes": int64,
        "downVotes": int64,
        "canVote": bool,
        "userVote": bool?,
        "hasVoted": bool,
        "voteCount": int64,
        "upVotePercent": int
      },
      "product": {
        "productId": int64,
        "price": int64?,
        "isForSaleOrIsPublicDomain": bool
      },
      "fiatProduct": {
        "purchasePrice": {
          "currencyCode": string,
          "quantity": {
            "significand": int64,
            "exponent": int
          }
        },
        "published": bool,
        "purchasable": bool
      }
    }
  ]
}

API de mercado

Puedes buscar artículos de avatar en el Marketplace usando la URL siguiente: https://catalog.roblox.com/v1/search/items/details?[params]

Puede reemplazar [params] con los adecuados parámetros de consulta para personalizar su buscar.

Parámetros de consulta

Puede especificar parámetros de búsqueda agregando una serie de parámetros y valores a la URL, cada uno separado por un & .

Usa los siguientes parámetros para buscar en el Mercado:

La siguiente URL buscará los primeros 10 "Gear" elementos en "Accesorios" clasificados por todos los tiempos ("Sort聚合") y relevancia ("SortType") creados por Roblox ("CreatorTargetId":

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

Campos de respuesta

Las respuestas de la API se devuelven en un formato JSON. La respuesta proporciona detalles de los recursos en la data clave utilizando los siguientes campos:

A continuación, se muestra un ejemplo de la salida de regreso esperada para un solo objeto:

{
	"keyword": null,
	"previousPageCursor": null,
	"nextPageCursor": "2_1_c541d05046b5c1c78a5d386b5e302243",
	"data": [
    {
        "id":527373900,
        "itemType":
        "Asset",
        "assetType":42,
        "name":"Restless Souls Bandana",
        "description":"This bandana won't help you blend in with ghosts, but at least you'll be stylish.",
        "productId":41270974,
        "genres":[
          "Scary",
          "Adventure"
          ],
        "itemStatus":[],
        "itemRestrictions":[],
        "creatorType":"User",
        "creatorTargetId":1,
        "creatorName":"Roblox",
        "price":300,
        "favoriteCount":15943,
        "offSaleDeadline":null
        }
	]
}