O que é a Yelp API?
A Yelp Fusion API permite aos usuários acessar conteúdo local e avaliações de milhões de empresas dos setores de hospitalidade e serviços em 32 países. O conteúdo do Yelp pode ser usado para o desenvolvimento de aplicativos e sites.
Como obter a Chave de API do Yelp?
Obter sua Fusion API key é rápido e fácil. Para obtê-la, siga estas diretrizes simples da Yelp API.
- Passo 1 – Criar uma conta
Primeiro, faça login no portal de desenvolvedores com sua conta Yelp existente ou crie uma nova.
Você pode continuar usando o serviço Yelp via Facebook, Google ou Apple ID. A outra opção é se cadastrar com seu endereço de e-mail. Nesse caso, você receberá um e-mail de confirmação — não se esqueça de seguir o link nele para verificar sua conta.
- Passo 2 – Comece com a Fusion API
Depois de fazer login no Yelp Developers, role até o final da primeira página e pressione o botão Explorar Yelp Fusion.
Você chegará à seção Fusion API do portal. Clique no botão Começar.
- Passo 3 – Criar um App
Crie seu primeiro Yelp App para receber sua chave de API Fusion. Preencha os campos obrigatórios no formulário, concorde com os Termos de Uso da Yelp API e com os Requisitos de Exibição. Em seguida, comprove que você é humano e clique em Criar Novo App.
Depois disso, você obterá o ID do App e a Chave de API. Salve-os para começar a usar o seu App.
Como usar a Yelp API?
Existem vários tipos de APIs, que basicamente podem ser divididos em soluções para pequenas empresas ou grandes empresas e para negócios de médio ou grande porte e potenciais parceiros do Yelp. Os primeiros estão incluídos na Yelp Fusion API e estão disponíveis gratuitamente para todos. Os últimos exigem um acesso especial, para o qual você precisa se inscrever e aguardar a decisão da empresa.
A Yelp Fusion API permite obter conteúdo local e avaliações de milhões de empresas dos setores de hospitalidade e serviços em 32 países.
O conteúdo do Yelp pode ser usado para desenvolvimento de aplicativos e sites, ajudando seus usuários a encontrar os melhores lugares e prestadores de serviço em uma determinada localidade e compará-los pela classificação e avaliações de clientes. A Yelp Fusion API utiliza autenticação por chave privada para validar todos os endpoints.
Preços e Limites
Todas as soluções estão abertas e disponíveis gratuitamente para acesso padrão. Embora haja limites da Yelp API para chamadas com volumes adicionais de limite de taxa fornecidos caso a caso. Ou seja, você precisa se inscrever para elas descrevendo seu projeto em todo o seu potencial. Depois disso, você deverá aguardar a decisão deles.
A API do Yelp possui vários tipos de limites. O primeiro é a limitação de taxa QPS (Queries-Per-Second, consultas por segundo). Se você fizer consultas à Yelp API muito rapidamente, pode receber erros HTTP 429. Se vir o erro com frequência, tente reduzir a velocidade das chamadas da API.
Além do QPS, há também um limite de chamadas de API por dia.
| Limite de Taxa – Limite Diário | O número máximo de chamadas que um usuário pode fazer por dia |
| RateLimit-Remaining | O número de chamadas restantes para hoje |
| Tempo de Reinicialização do Limite de Taxa | O momento em que a janela atual de limite de taxa vai expirar |
Exemplos da Yelp API
- API de Avaliações do Yelp
Esse tipo de consulta é um exemplo da Yelp Fusion API que oferece a oportunidade de exibir até três trechos de avaliações de uma empresa. Também existe uma solução Private Yelp Review API que permite aos parceiros aprovados do Yelp recuperar avaliações que são publicamente visíveis na plataforma.
Para exibir um número ilimitado de avaliações da sua empresa no site, use o widget Elfsight Yelp Reviews disponível gratuitamente!
- API de Negócios do Yelp
A Fusion API oferece um conjunto completo de endpoints de negócios que retornam conteúdo empresarial detalhado.
Estes são os endpoints básicos usados:
Nome Caminho Descrição Busca de Negócios /businesses/search Pesquise por palavra-chave, categoria, localização, faixa de preço, etc. Pesquisa por Telefone /businesses/search/phone Pesquisar por número de telefone. Pesquisa de Transações /transactions/{transaction_type}/search Pesquise serviços que aceitam transações de entrega de comida. Detalhes da Empresa /businesses/{id} Obtenha dados completos do negócio, como nome, endereço, telefone, fotos, avaliação no Yelp, faixas de preço e horários de funcionamento. Conexão de Negócios /businesses/matches Encontre o negócio no Yelp que corresponde exatamente à localização informada. - API de Busca do Yelp
here. The API does not return businesses without any reviews.”>Este endpoint retorna até 1000 empresas com base nos critérios de busca fornecidos. Ele traz algumas informações básicas sobre a empresa. A Fusion Search API inclui uma ampla variedade de categorias, que vão de Artes, Beleza, Educação Finanças e muito mais. A lista completa de categorias da Yelp API pode ser encontrada aqui. A API não retorna empresas sem avaliações.
Mudanças na API do Yelp
A versão atual da Yelp API é a v3, que substituiu a Yelp API v2 em 2018.
A versão v2 utilizava OAuth 2.0 para autenticar solicitações à API. Para simplificar esse processo, a partir de 1º de março de 2018 a API passou a usar apenas chaves de API e deixou de usar OAuth 2.0 para as consultas.
Com OAuth 2.0, o processo de autenticação foi:
- Obtenha seu ID do Cliente no App de Gerenciamento.
- Faça uma requisição ao endpoint de token para obter um token de acesso.
- Coloque o token de acesso no cabeçalho da requisição e comece a fazer requisições à API.
Com apenas chaves de API, esse processo é:
- Obtenha sua Chave de API na página Gerenciar App.
- Coloque a Chave de API no cabeçalho da requisição.
Agora não é necessário enviar uma requisição ao endpoint para obter um token de acesso. Sua API Key não expira, então você não precisa se preocupar em gerar novas chaves.
Documentação da API do Yelp
O site para desenvolvedores do Yelp contém todos os tutoriais da Yelp API, explicando seus princípios de funcionamento e uso prático. Você pode encontrá-lo aqui. Lá você também pode criar suas aplicações e trabalhar com a Fusion API e Yelp GraphQL – uma linguagem de consulta para APIs. A coleção abrangente de documentação para desenvolvedores, incluindo APIs de parceiros especiais, está disponível no Yelp Developer Portal. O acesso a essas APIs de Publicidade, APIs de Reserva e outras pode ser obtido apenas mediante a criação de uma aplicação.
FAQ
Muitos dados de negócios e outros atributos estão presentes na plataforma Yelp, mas não constam na documentação da API para desenvolvedores do Yelp. Como acessá-los?
Como posso filtrar os dados do Yelp por país?
A API do Yelp busca resultados em todas as geografias onde o serviço está disponível. Se quiser filtrar os resultados de suas consultas para uma cidade específica, certifique-se de usar o parâmetro de localização ao usar a API de busca.
Por que a Yelp API não retorna alguns negócios que podem ser encontrados no Yelp?
A API do Yelp retorna apenas informações de negócios com conteúdo gerado por usuários do Yelp. Especificamente, é necessário ter pelo menos uma avaliação de cliente.
Posso escolher quais avaliações exibir em uma consulta de API?
A ordenação das avaliações leva em conta recência, votos dos usuários e outros fatores de qualidade para ajudar os consumidores a tomar decisões informadas. A API do Yelp não pode ser configurada para exibir trechos de avaliações alternativos ou selecionados manualmente.
Como posso obter mais chamadas de API?
Chamadas adicionais de API são concedidas com base no tráfego real de usuários do site ou do aplicativo, normalmente após o lançamento do produto. Tente minimizar as chamadas de API durante a fase de desenvolvimento, armazenando em cache os dados do Yelp por até 24 horas e salvando os IDs de negócios. Você pode enviar um e-mail para [email protected] com seu ID do Cliente da API do Yelp e informar à empresa sobre o seu produto ou integração, bem como o número exato de requisições diárias que pretende utilizar.
