{
"ok": true,
"data": {
"url": "https://github.com",
"final_url": "https://github.com",
"status_code": 200,
"title": "GitHub · Change is constant. GitHub keeps you ahead. · GitHub",
"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.",
"image": "https://images.ctfassets.net/8aevphvgewt8/76epZKB2wF998m4e4bLLXn/c505f20b00ec70b88b1be5aec42c4be4/OG_image.jpg",
"site_name": "GitHub",
"favicon": "https://github.com/fluidicon.png",
"canonical": "https://github.com",
"type": "object",
"twitter_card": "summary_large_image",
"language": "en"
},
"meta": {
"request_id": "74494e4e82aa4879aa49a381209f3935",
"api": "link-preview",
"version": "1",
"elapsed_ms": 2177,
"llm_used": false,
"cache_hit": false,
"warnings": [],
"plan": null
}
}
curl --location --request GET 'https://zylalabs.com/api/15181/link+preview+unfurl+api/40591/preview+get?url=https://github.com' --header 'Authorization: Bearer YOUR_API_KEY'
{
"ok": true,
"data": {
"url": "https://github.com",
"final_url": "https://github.com",
"status_code": 200,
"title": "GitHub · Change is constant. GitHub keeps you ahead. · GitHub",
"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.",
"image": "https://images.ctfassets.net/8aevphvgewt8/76epZKB2wF998m4e4bLLXn/c505f20b00ec70b88b1be5aec42c4be4/OG_image.jpg",
"site_name": "GitHub",
"favicon": "https://github.com/fluidicon.png",
"canonical": "https://github.com",
"type": "object",
"twitter_card": "summary_large_image",
"language": "en"
},
"meta": {
"request_id": "42b5e2c3a7ee46d9ad148a81bd46bc06",
"api": "link-preview",
"version": "1",
"elapsed_ms": 2616,
"llm_used": false,
"cache_hit": false,
"warnings": [],
"plan": null
}
}
curl --location --request POST 'https://zylalabs.com/api/15181/link+preview+unfurl+api/40592/preview+post' --header 'Authorization: Bearer YOUR_API_KEY'
--data-raw '{"url":"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 Expandir prévia do link 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.
Expanda uma URL em metadados Open Graph e Twitter Card, além de um favicon. A captura de tela está indisponível no momento; as prévias de metadados são totalmente compatíveis
Retorna o título, a descrição, a imagem, o nome do site, o favicon, a URL canônica e o tipo de cartão que um aplicativo de bate-papo ou CMS exibe abaixo de um link
Ele lê primeiro as tags Open Graph e Twitter Card e, em seguida, recorre ao título e à meta descrição do HTML
A captura de tela está indisponível no momento; as prévias de metadados são totalmente compatíveis .
Hosts privados, endereços de metadados e portas que não sejam da web são rejeitados antes que a página seja buscada
Envie GET /v1/preview?url=https://github.com/ com seu cabeçalho X-Api-Key A resposta JSON contém os metadados da página e o favicon
Foi desenvolvido para aplicativos de bate-papo, editores de CMS e qualquer produto que precise exibir um cartão rico abaixo de um link colado
Ambos os endpoints retornam metadados do link O endpoint GET recebe a URL de destino como um parâmetro de consulta enquanto o endpoint POST recebe a URL no corpo da solicitação JSON Os dados de pré-visualização usam a mesma estrutura geral de resposta
O objeto de dados pode incluir o URL solicitado, o URL final, o código de status HTTP, o título, a descrição, a imagem, o nome do site, o favicon, o URL canônico, o tipo de conteúdo, o valor do Twitter Card e o idioma
Final_url é o URL alcançado após redirecionamentos ou outras alterações de navegação Compare-o com url para identificar se o endereço original redirecionou para outra página
Canonical contém o URL preferencial declarado pela página, quando disponível. language identifica o idioma detectado ou declarado da página, como "en", ajudando os aplicativos a rotular ou processar as pré-visualizações adequadamente. .
Verifique primeiro o campo ok de nível superior Quando houver sucesso use data para a prévia e status_code para o resultado HTTP da página obtida Inspecione também os campos em busca de valores ausentes pois páginas individuais podem não fornecer todos os elementos de metadados
O objeto meta contém diagnósticos da solicitação, como request_id, nome da API, versão, elapsed_ms e outros metadados de processamento. Use request_id para correlacionar uma resposta com registros ou investigações de suporte
A resposta pode conter valores vazios ou ausentes em campos como image site_name favicon canonical ou twitter_card Os aplicativos devem tratar esses campos como opcionais e recorrer a exibições mais simples usando o título a descrição e o URL disponíveis
Use a imagem como arte principal da pré-visualização avançada e o favicon como ícone do site. Ambos são retornados como URLs, para que os clientes possam exibi-los em cartões ou listas, tratando com elegância os recursos ausentes, inacessíveis ou inadequados