Schema Socials: links de redes sociais do perfil

Documentação do schema Socials da API Ghosting. Conheça as plataformas suportadas e a estrutura dos links de redes sociais vinculados a um perfil.

O schema Socials descreve os links de redes sociais vinculados a um perfil Ghosting. Cada item do array contém a plataforma, a URL pública e, opcionalmente, a URL de um ícone. Esses links são exibidos na página pública do perfil e podem ser consumidos por bots, dashboards e outras integrações para enriquecer a apresentação de um usuário.

Estrutura de um item Socials

platform · string · required

Nome da plataforma de rede social. Valores suportados: discord, github, steam, twitter, instagram, youtube.

url · string (URL) · required

URL pública do perfil na respectiva plataforma.

iconUrl · string (URL) | undefined

URL opcional para um ícone customizado da plataforma. Quando ausente, a interface deve usar um ícone padrão baseado no nome da plataforma.

Plataformas suportadas

Plataforma	Exemplo de URL
discord	https://discord.gg/vkWVxrd9Bn
github	https://github.com/ihyos/PAYLINK
steam	https://steamcommunity.com/id/ghosting
twitter	https://twitter.com/usuario
instagram	https://instagram.com/usuario
youtube	https://youtube.com/@usuario

Exemplo JSON

{
  "socials": [
    {
      "platform": "discord",
      "url": "https://discord.gg/vkWVxrd9Bn"
    },
    {
      "platform": "github",
      "url": "https://github.com/ihyos/PAYLINK"
    },
    {
      "platform": "steam",
      "url": "https://steamcommunity.com/id/ghosting"
    }
  ]
}

Quando iconUrl não estiver presente, use o nome da plataforma para mapear ícones padrão da sua biblioteca de UI (como FontAwesome, Tabler ou Heroicons).

A ordem dos itens no array socials respeita a ordem definida pelo usuário no painel do Ghosting. Mantenha essa ordem ao renderizar para preservar a preferência do perfil.

Leia mais

Schema User

Veja como o array socials está aninhado no schema User completo.

Schema Badges

Conheça os selos de verificação que complementam a identidade pública do perfil.