{
"description": null,
"favicon": "https://zylalabs.com/favicon.ico",
"image": null,
"siteName": "zylalabs.com",
"title": "Just a moment...",
"url": "https://zylalabs.com/"
}
curl --location --request GET 'https://zylalabs.com/api/13352/link+preview+-+url+unfurl+api/28457/preview?url=https://zylalabs.com' --header 'Authorization: Bearer YOUR_API_KEY'
{
"results": [
{
"description": "Stripe is a financial services platform that helps all types of businesses accept payments, build flexible billing models, and manage money movement.",
"favicon": "https://images.stripeassets.com/fzn2n1nzq965/1hgcBNd12BfT9VLgbId7By/01d91920114b124fb4cf6d448f9f06eb/favicon.svg",
"image": "https://images.stripeassets.com/fzn2n1nzq965/XtX984S1GJVsVOXFC7kMu/01988281e867728dfb09aa7793a6e3b9/Stripe.jpg?q=80",
"siteName": "stripe.com",
"title": "Stripe | Financial Infrastructure to Grow Your Revenue",
"url": "https://stripe.com/"
},
{
"description": "Join the world's most widely adopted, AI-powered developer platform where millions of developers, businesses, and the largest open source community build software that advances humanity.",
"favicon": "https://github.com/fluidicon.png",
"image": "https://images.ctfassets.net/8aevphvgewt8/4pe4eOtUJ0ARpZRE4fNekf/f52b1f9c52f059a33170229883731ed0/GH-Homepage-Universe-img.png",
"siteName": "GitHub",
"title": "GitHub · Change is constant. GitHub keeps you ahead.",
"url": "https://github.com/"
}
]
}
curl --location --request POST 'https://zylalabs.com/api/13352/link+preview+-+url+unfurl+api/28458/preview+batch' --header 'Authorization: Bearer YOUR_API_KEY'
--data-raw '{
"urls": [
"https://stripe.com",
"https://github.com"
]
}'
Após se cadastrar, cada desenvolvedor recebe uma chave de acesso à API pessoal, uma combinação única de letras e dígitos para acessar nosso endpoint de API. Para autenticar com a Pré-visualização do Link - Desdobramento de URL API basta incluir seu token Bearer no cabeçalho Authorization.
| Cabeçalho | Descrição |
|---|---|
Authorization
|
Obrigatório
Deve ser Bearer access_key. Veja "Sua chave de acesso à API" acima quando você estiver inscrito.
|
Sem compromisso de longo prazo. Faça upgrade, downgrade ou cancele a qualquer momento. O teste gratuito inclui até 50 requisições.
(Economize 2 meses com cobrança anual 🎉)
Empresas líderes confiam em nós
Dê ao seu aplicativo as prévias de link ricas que os usuários esperam — os cartões que Slack, iMessage e Twitter mostram quando você cola uma URL. Envie qualquer URL e receba um JSON limpo com o título da página, descrição, imagem de prévia, nome do site e favicon.
Como funciona: a API busca a página no servidor e lê primeiro as tags OpenGraph, depois as tags do Twitter Card, e em seguida recorre ao HTML simples (, descrição meta), para que você receba resultados úteis mesmo de páginas sem tags sociais. As buscas são seguras contra SSRF (endereços privados/internos bloqueados), têm limites de tamanho e tempo, e os resultados podem ser armazenados em cache por uma hora.
Pontos finais: GET /preview?url=... para uma URL; POST /preview/batch para até 10 URLs em uma única chamada. Erros usam o JSON padrão de detalhes de problemas com códigos claros legíveis por máquina.
Construído para: aplicativos de chat e mensagens, CMSs, agendadores sociais, ferramentas de leitura posterior, fóruns — em qualquer lugar onde um link colado deva se tornar um cartão.
O endpoint GET /preview retorna um cartão de prévia rico contendo o título, descrição, imagem, nome do site, favicon e URL do link fornecido O endpoint POST /preview/batch retorna dados semelhantes para até 10 URLs em um formato estruturado permitindo o processamento em lote de prévias de links
Os campos principais nos dados de resposta incluem "título" "descrição" "imagem" "nomeDoSite" "favicon" e "url" Esses campos fornecem informações essenciais sobre a página vinculada permitindo que os usuários criem prévias ricas
Os dados da resposta estão organizados no formato JSON Para o endpoint GET ele retorna um único objeto com campos para a pré-visualização do link O endpoint POST retorna um objeto contendo um array "results" onde cada entrada corresponde a uma URL e inclui seus respectivos dados de pré-visualização
Cada endpoint fornece informações como o título da página, descrição, imagem de visualização, nome do site, favicon e a URL original. Estes dados ajudam os usuários a gerar visualizações de links visualmente atraentes para várias aplicações
Os usuários podem personalizar suas solicitações especificando o parâmetro de URL na solicitação GET ou fornecendo um array de URLs na solicitação POST Essa flexibilidade permite que os usuários recuperem pré-visualizações de links específicos ou vários links em uma única chamada
A API busca dados da página da web alvo lendo as tags OpenGraph as tags Twitter Card e as descrições meta HTML Essa abordagem de múltiplas fontes garante que os usuários recebam informações relevantes mesmo que algumas tags estejam faltando
Casos de uso típicos incluem gerar pré-visualizações de links para aplicativos de chat e mensagens, sistemas de gerenciamento de conteúdo, agendadores de mídia social e fóruns Essa funcionalidade melhora a experiência do usuário ao fornecer um contexto visual rico para links compartilhados
Se uma URL retornar resultados parciais ou vazios, a API ainda fornecerá os campos disponíveis, como o nome do site e o favicon. Os usuários podem implementar lógica de fallback em suas aplicações para lidar com esses casos de forma elegante, garantindo uma experiência do usuário consistente