Documentação da API do Crate
Novo!
Fique a par das novidades do Crate no seu servidor de Discord adicionando o bot oficial do Crate.
v2.0.0
# Projetos
Projects::Get
Descrição: Obter uma lista de projetos a partir de parâmetros.
Parâmetros:
id - ID
shortId - ID curto
author - ID do autor
categories - categorias
languages - idiomas
Como usar
Use a API do Crate para receber informações de perfis, projetos e publicações do Crate.
Para receber qualquer informação precisa de enviar um pedido de HTTP (HTTP Request) do tipo GET ou POST (depende da função) para https://pptgamespt.wixsite.com/crate/_functions/api/funcao em que funcao é o nome da função que representa o pedido.
Perfil
A função getProfiles procura perfis com a propriedade com valor especificados.
Tipo
POST
Nome
getProfiles
Parâmetros
-
query - Array de queries
– Tipos de queries:
-
{ "type": "eq", "prop": <propriedade>, "value": <valor> } (item igual ao valor)
-
{ "type": "ne", "prop": <propriedade>, "value": <valor> } (item diferente do valor)
-
{ "type": "gt", "prop": <propriedade>, "value": <valor> } (item maior que o valor)
-
{ "type": "ge", "prop": <propriedade>, "value": <valor> } (item maior ou igual ao valor)
-
{ "type": "lt", "prop": <propriedade>, "value": <valor> } (item menor que o valor)
-
{ "type": "le", "prop": <propriedade>, "value": <valor> } (item menor ou igual ao valor)
-
{ "type": "cont", "prop": <propriedade>, "value": <valor> } (item contém o valor)
-
{ "type": "some", "prop": <propriedade>, "value": <valor> } (item está contido no valor)
-
{ "type": "rand" } (selecionar itens de forma aleatória)
-
{ "type": "asc", "prop": <propriedade> } (ordenar de forma ascendente)
-
{ "type": "desc", "prop": <propriedade> } (ordenar de forma descendente)
– Propriedades válidas:
-
id - ID da conta
-
shortId - ID curto da conta
-
name - nome da conta
-
description - descrição do perfil
-
url - caminho do URL do perfil (pptgamespt.wixsite.com/crate/perfil/caminho)
-
credits - quantidade de Credits
-
xp - quantidade de XP
-
followers - número de seguidores
-
max - número máximo de resultados (deve ser um número inteiro compreendido entre 1 e 50)
Conteúdo devolvido
É devolvida uma lista com os perfis que correspondem com a query. Cada perfil tem as seguintes informações:
id - ID (String)
shortId - ID curto (String)
name - nome da conta (String)
profilePicture - imagem de perfil (String)
profileBanner - ilustração de fundo do perfil (String)
profilePath - caminho do URL do perfil (pptgamespt.wixsite.com/crate/perfil/caminho) (String)
description - descrição do perfil (String)
email - endereço de e-mail (caso o perfil não tenha o e-mail como informação pública, o valor desta propriedade é undefined) (String)
credits - quantidade de Credits (caso o perfil não tenha os Credits como informação pública, o valor desta propriedade é undefined) (Number)
xp - quantidade de XP (Number)
followers - número de seguidores (Number)
Exemplo
POST https://pptgamespt.wixsite.com/crate/_functions/getProfiles
REQUEST:
{
"query": [
{
"type": "cont",
"prop": "name",
"value": "Example"
},
"type": "desc",
"prop": "xp"
}
],
"max": 10
}
RESPONSE:
[
{
"id": "0001",
"shortId": "a1b2c",
"name": "Example 1",
"profilePicture": "https://...",
"profileBanner": "https://...",
"profilePath": "example1",
"description": "This is example 1.",
"email": "example1@mail.com",
"credits": 45.12,
"xp": 6301,
"followers": 6
},
{
"id": "0002",
"shortId": "c3d4e",
"name": "Example 2",
"profilePicture": "https://...",
"profileBanner": "https://...",
"profilePath": "example2",
"description": "This is example 2.",
"email": "example2@mail.com",
"credits": 65.03,
"xp": 3120,
"followers": 11
}
]
Projeto
A função getProjects procura projetos com a propriedade com valor especificados.
Nota: Apenas são devolvidos projetos públicos.
Tipo
POST
Nome
getProjects
Parâmetros
prop - propriedade (id (ID), shortId (ID curto), title (título), price (preço))
value - valor da propriedade
Conteúdo devolvido
id - ID (String)
shortId - ID curto (String)
title - título (nome do projeto) (String)
icon - ícone (String)
author - id da conta do autor do projeto (String)
description - descrição (objeto com propriedade plaintext (formato texto simples) e html (formato código HTML)) (Object)
price - preço (Number)
images - Imagens (Array: String)
trailer - URL do trailer (String)
categories - categorias (Array: String)
type - tipo de projeto (Jogo, Sistema, Utilitário) (String)
languages - idiomas (Array: String)
views - número de visualizações (Number)
downloads - número de downloads (Number)
likes - número de gostos (Number)
dislikes - número de não gostos (Number)
comments - número de comentários (Number)
rating - classificação de 0.0 a 1.0 (Number)
ageRating - faixa etária (L, 7, 12, 16, 18) (String)
launchType - tipo de lançamento (Versão final, Acesso antecipado, Em breve) (String)
requirements - requisitos (Array: String)
Exemplo
POST https://pptgamespt.wixsite.com/crate/_functions/getProjects
Content:
{
"query": "cont",
"prop": "name",
"value": "Example"
}
RESPONSE:
[
{
"title": "Example 1",
"icon": "https://...",
"author": "0001",
"description": {
"plaintext": "This is example 1.",
"html": "<b>This is example 1.</b>"
},
"price": 0
},
{
"title": "Example 2",
"icon": "https://...",
"author": "0002",
"description": {
"plaintext": "This is example 2.",
"html": "<b>This is example 2.</b>"
},
"price": 3.99
}
]