Integração com o Yelp

Introdução

Integrar os ricos dados e serviços do Yelp em seu site de eDirectory pode aumentar significativamente seu valor, fornecendo aos usuários avaliações confiáveis e informações sobre empresas. Essa integração é possível por meio da API do Yelp (Interface de Programação de Aplicações), que requer uma chave de API única para acesso. Criar essa chave é um processo simples que envolve o registro para uma conta de desenvolvedor do Yelp e a geração de suas credenciais exclusivas. Este guia passo a passo o levará pelo processo de obtenção de sua chave de API do Yelp e integração com sua plataforma de eDirectory.

Passo 1: Criando uma Conta de Desenvolvedor do Yelp

1. Visite o site de Desenvolvedores do Yelp: Acesse 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, será necessário criar uma nova seguindo o processo de registro na tela.

3. Acesse a API de Locais do Yelp: Na página seguinte, localize e clique em "API de Locais do Yelp"

4. Inicie um Teste Gratuito: Clique no botão "Iniciar um teste gratuito".

5. Seleção de plano: Selecione um dos planos para criar o aplicativo

Passo 2: Criando um Novo Aplicativo

1. Você será imediatamente solicitado a criar um novo aplicativo.
2. Preencha os Detalhes do Aplicativo: Você será apresentado a um formulário para fornecer informações sobre sua aplicação. Por favor, complete os seguintes campos:
   • Nome do Aplicativo: Digite um nome único e descritivo para sua aplicação. Isso ajudará você a identificá-lo dentro da sua conta de Desenvolvedor Yelp.
   • Site do Aplicativo: 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 Aplicativo: Selecione a indústria que melhor descreve seu negócio ou site.
   • Email de Contato: Digite seu endereço de email válido. O Yelp pode usar isso para comunicação sobre seu acesso à API.
   • Descrição do Aplicativo: 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.
3. 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.
4. Verifique se você não é um robô: Complete o desafio CAPTCHA conforme solicitado.
5. Clique em "Criar Aplicativo": Após preencher todas as informações necessárias e aceitar os termos, clique no botão "Criar Aplicativo" para gerar sua chave da API do Yelp.

Passo 3: Recuperando Sua Chave da API

1. Uma vez que seu aplicativo for criado com sucesso, você será redirecionado automaticamente para o seu Painel do Aplicativo dentro do portal de Desenvolvedor Yelp.
2. Localize a seção claramente rotulada "Chave da API" em seu Painel do Aplicativo. Sua chave única da API do Yelp será exibida nesta seção.
3. Copie Sua Chave da API: Selecione cuidadosamente e copie toda a chave da API. Geralmente, é 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, você pode integrá-la em seu site eDirectory para começar a acessar e exibir os dados valiosos 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 guia "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 dentro das 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 ciente do uso da sua API e familiarize-se com quaisquer limites de taxa impostos pelo Yelp em solicitações da API. Exceder esses limites pode levar a interrupções temporárias no serviço. O Painel do Desenvolvedor Yelp pode fornecer informações sobre seu uso da API.

Exibição de Avaliações

Uma vez que a chave da API do Yelp tenha sido validada e salva com sucesso dentro das suas configurações do eDirectory, o sistema tentará automaticamente associar listas em seu site com os negócios correspondentes no Yelp. Esse processo de correspondência geralmente se baseia na identificação de listas com o mesmo nome e na mesma localização em que aparecem no Yelp. Se uma correspondência for encontrada, junto com outras informações relevantes, como imagens, avaliações, número de telefone, e mais, as avaliações do Yelp para aquele negócio serão carregadas e exibidas automaticamente na página de listagem correspondente em seu site eDirectory.

Conclusão

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