Integração com o Yelp

Introdução

Integrar os dados e serviços do Yelp em seu site eDirectory pode aumentar significativamente seu valor, proporcionando aos usuários avaliações confiáveis e informações sobre negócios. Essa integração é possibilitada através da API do Yelp (Interface de Programação de Aplicativos), que requer uma chave de API única para acesso. Criar essa chave é um processo simples que envolve o registro de uma conta de desenvolvedor do Yelp e a geração de suas credenciais únicas. Este guia passo a passo o guiará pelo processo de obtenção de sua chave de API do Yelp e sua integração com sua plataforma eDirectory.

Passo 1: Criando uma Conta de Desenvolvedor do Yelp:

1. Visite o site de Desenvolvedores do Yelp: Navegue até https://www.yelp.com/developers.

2. Faça login ou crie uma conta:
   • Se você já tem uma conta de usuário do Yelp, faça login usando seu endereço de e-mail e senha existentes.
   • Se você não tem uma conta no Yelp, precisará criar uma nova seguindo o processo de registro na tela.

3. Acesse o Yelp Fusion: Na página seguinte, localize e clique em "Yelp Fusion."

4. Gerenciar App: Clique no botão "Gerenciar App".

Passo 2: Criando um Novo App:

1. Acesse o Painel de Desenvolvedores do Yelp. Se você não for redirecionado automaticamente após o Passo 1, normalmente pode encontrar o link do painel no site de Desenvolvedores do Yelp.
2. Clique na opção "Criar App".

3. Preencha os Detalhes do App: Você será apresentado a um formulário para fornecer informações sobre sua aplicação. Por favor, complete os seguintes campos:
   • Nome do App: Insira um nome único e descritivo para sua aplicação. Isso ajudará você a identificá-la dentro de sua conta de Desenvolvedor do Yelp.
   • Site do App: Forneça a URL completa (por exemplo, https://www.seusite.com ) do site onde você pretende integrar a funcionalidade da API do Yelp (seu site eDirectory).
   • Indústria do App: Selecione a indústria que melhor descreve seu negócio ou site.
   • E-mail de Contato: Digite seu endereço de e-mail válido. O Yelp pode usar isso para comunicação sobre seu acesso à API.
   • Descrição do App: Descreva brevemente o propósito e a funcionalidade de como você planeja usar a API do Yelp em seu site eDirectory. Seja claro e conciso.
4. Leia e Aceite os Termos de Uso: Revise cuidadosamente os Termos de Uso da API do Yelp. Você precisará indicar que leu e concorda com esses termos, geralmente marcando uma caixa.
5. Verifique se você não é um robô: Complete o desafio CAPTCHA conforme solicitado.
6. Clique em "Criar App": Após preencher todas as informações necessárias e aceitar os termos, clique no botão "Criar App" para gerar sua chave da API do Yelp.

Passo 3: Recuperando Sua Chave da API:

1. Uma vez que seu app é criado com sucesso, você será redirecionado automaticamente para o seu Painel de App dentro do portal de Desenvolvedores do Yelp.
2. Localize a seção claramente rotulada "Chave da API" no seu Painel de App. Sua chave única da API do Yelp será exibida nesta seção.
3. Copie Sua Chave da API: Selecione e copie cuidadosamente toda a chave da API. Normalmente, é uma longa sequência de caracteres alfanuméricos.

Passo 4: Implementando Sua Chave da API do Yelp no eDirectory:

Agora que você obteve sua chave única da API do Yelp, pode integrá-la ao seu site eDirectory para começar a acessar e exibir os valiosos dados do Yelp.

1. Faça login no seu painel de gerenciamento do site em seu site eDirectory usando suas credenciais administrativas.
2. Navegue até Configurações → Configurações Gerais → Plugins.

3. Na aba "Plugins", encontre a seção dedicada às configurações de integração do Yelp.
4. Dentro das configurações de integração do Yelp, localize o campo rotulado "Chave da API." Cole a chave da API do Yelp que você copiou no Passo 3 neste campo.
5. Clique no botão "Validar Chave do Yelp" (se disponível) para garantir que a chave esteja formatada corretamente e aceita pelo sistema.
6. Por fim, clique no botão "Salvar Alterações" para armazenar sua chave da API do Yelp nas configurações do seu eDirectory.

Notas Importantes:

• Proteja Sua Chave da API: Trate sua chave da API do Yelp com o mesmo nível de segurança que qualquer outra credencial de login sensível. Evite compartilhá-la publicamente ou incorporá-la diretamente no código do lado do cliente (como JavaScript no front-end do seu site), pois isso pode permitir acesso não autorizado.
• Revise os Termos de Uso da API do Yelp: É crucial ler e entender completamente os Termos de Uso da API do Yelp para garantir que sua integração esteja em conformidade com suas diretrizes, políticas e quaisquer restrições sobre o uso ou exibição de dados.
• Monitore o Uso e os Limites: Esteja atento ao uso da sua API e familiarize-se com quaisquer limites de taxa impostos pelo Yelp em requisições da API. Exceder esses limites pode levar a interrupções temporárias do serviço. O Painel de Desenvolvedores do Yelp pode fornecer insights sobre o uso da sua API.

Exibição da Revisão:

Uma vez que a chave da API do Yelp seja validada e salva com sucesso nas configurações do seu eDirectory, o sistema tentará automaticamente associar anúncios em seu site com os negócios correspondentes no Yelp. Este processo de correspondência normalmente se baseia na identificação de anúncios com o mesmo nome e na mesma localização em que aparecem no Yelp. Se uma correspondência for encontrada, juntamente com outras informações relevantes, como imagens, avaliações, número de telefone e mais, as avaliações do Yelp para esse negócio serão carregadas e exibidas automaticamente na página do anúncio correspondente em seu site eDirectory.

Conclusão

Seguindo diligentemente estes passos, você terá criado com sucesso uma chave da API do Yelp e a integrado ao seu site eDirectory, desbloqueando o potencial para enriquecer sua plataforma com valiosas avaliações e informações de negócios do Yelp para seus usuários.