A integração com a API de Recomendações permite que os clientes da YOM consultem e baixem as recomendações de pedido geradas para seus comércios, por meio de endpoints REST sobre HTTPS com autenticação OAuth 2.0 (client credentials).
A YOM gera recomendações de pedido que ficam disponíveis para o cliente por meio de endpoints REST. O cliente realiza requisições GET para obter as listas de recomendações de seus comércios. O acesso é:
<aside> ℹ️
A disponibilidade de dados depende da existência de recomendações geradas para a sua organização no ambiente correspondente.
</aside>
O contrato técnico se aplica tanto para Staging quanto para Produção. Os endpoints, parâmetros, estrutura de resposta, autenticação e regras de consumo são idênticos em ambos os ambientes.
| Ambiente | URL base (BASE_URL) |
Domínio da sua organização |
|---|---|---|
| Staging | https://api.solopide.me |
{cliente}.solopide.me |
| Produção | https://api.youorder.me |
{cliente}.youorder.me |
<aside> 🔑
As credenciais são específicas para cada ambiente e serão entregues pela YOM por meio de um canal seguro. Não utilize credenciais de Staging em Produção, nem vice-versa.
</aside>
Etapas anteriores
<aside> <img src="/icons/arrow-left_gray.svg" alt="/icons/arrow-left_gray.svg" width="40px" />
</aside>
Próximas etapas
<aside> <img src="/icons/arrow-right_gray.svg" alt="/icons/arrow-right_gray.svg" width="40px" />
</aside>