Requisitos técnicos

A integração Webhooks permite que a YOM envie notificações automáticas aos sistemas dos nossos clientes em tempo real. Para implementar essa integração, é necessário cumprir os seguintes requisitos técnicos:

🌐 Endpoint de recebimento do Webhook

O cliente deve fornecer uma URL que atuará como o endpoint de recebimento do webhook. Esse endpoint deve ser capaz de receber solicitações HTTP POST da YOM.

URL de recebimento: <tu_dominio>/webhooks/yom
Exemplo de uso: POST <tu_dominio>/webhooks/yom

🔒 Autenticação e segurança com a YOM

Para acessar os endpoints da YOM, é necessário criar um token com base em um client_id e um client_secret que serão entregues aos nossos clientes.

Os detalhes do endpoint para gerar o token são os seguintes:

URL
- Staging
  - https://api.solopide.me/api/v2/auth/tokens/grant
- Produção
  - https://api.youorder.me/api/v2/auth/tokens/grant
Método
- POST
Cabeçalhos (Headers):
- Content-Type: application/json

Corpo da solicitação (Request Body):

É enviado no formato JSON. Exemplo:

{
    "client_id": "nkguw0p01dafkQoRPTXO6",
    "client_secret": "IeC2SSfZEdFb8hASD#faskSADT83Y0tGN2CJmZWHY",
    "grant_type": "client_credentials"
}

Exemplo da resposta:

{
	"accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI2NzJlMDUwYTBiMzFlY2UyYzhlMzkxOGYiLCJyb2xlcyI6WyJhZG1pbiJdLCJkb21haW4iOiJpMmJ0ZXN0LnNvbG9waWRlLm1lIiwiY3VzdG9tZXJJZCI6IjY3MmUwNTA3MGIzMWVjZTJjOGUzOTE3YiIsInBlcm1pc3Npb25zIjpbImNhdGVnb3J5OnJlYWQiLCJjYXRlZ29yeTpidWxrIiwiY29tbWVyY2U6d3JpdGUiLCJjdXN0b21lcjpyZWFkIiwiZGlzY291bnQtbGltaXRzOnJlYWQiLCJkaXNjb3VudC1saW1pdHM6d3JpdGUiLCJkaXNjb3VudC1saW1pdHM6YnVsayIsImRpc2NvdW50LWxpbWl0czpkZXN0cm95IiwiZG9tYWluOnJlYWQiLCJkb21haW46YnVsayIsImdyb3VwOnJlYWQiLCJncm91cDp3cml0ZSIsImdyb3VwOmRlc3Ryb3kiLCJncm91cDpidWxrIiwiaW1wb3J0OndyaXRlIiwiaW50ZWdyYXRpb24taW5mbzpyZWFkIiwiaW50ZWdyYXRpb24taW5mbzp3cml0ZSIsIm9yZGVyOnJTpyZWFkIiwib3ZlcnJpZGU6d3JpdGUiLCJvdmVycmlkZTpidWxrIiwicGF5bWVudDpyZWFkIiwicGVuZGluZy1kb2N1bWVudDpidWxrIiwicHJvbW90aW9uOnJlYWQiLCJwcm9tb3Rpb246d3JpdGUiLCJwcm9tb3Rpb246YnVsayIsInNhbGVzbWFuOnJlYWQiLCJzYWxlc21hbjp3cml0ZSIsInNhbGVzbWFuOmJ1bGsiLCJzZWdtZW50OnJlYWQiLCJzZWdtZW50OndyaXRlIiwic2VnbWVudDpidWxrIiwic2VnbWVudDpidWxrLWRlc3Ryb3kiLCJzZWxsZXI6cmVhZCIsInNlbGxlcjpidWxrIiwic2t1OnJlYWQiLCJza3U6YnVsayIsInN1cGVydmlzb3I6YnVsayIsInN0b3JlOnJlYWQiLCJzdWdnZXN0aW9uOnJlYWQiLCJzdWdnZXN0aW9uOmJ1bGsiLCJ1cGxvYWRlcjpyZWFkIiwidXBsb2FkZXI6d3JpdGUiXSwidmVyaWZpZWQiOnRydWUsImJsb2NrZWQiOmZhbHNlLCJ0eXBlIjoiYXBwbGljYXRpb24iLCJjb25uZWN0aW9uSWQiOiI2N2M3MWZhNmU1NzcyMmY2NGU3NjdiZDYiLCJpYXQiOjE3NDExMTI4NjksImV4cCI6MTc0MTExMzc2OX0.lTklbBucJ6o-CFAdSGeO5rfJM-VUmw_xEbQVdoIaUKE",
	"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI2NzJlMDUwYTBiMzFlY2UyYzhlMzkxOGYiLCJyb2xlcyI6WyJhZG1pbiJdLCJkb21haW4iOiJpMmJ0ZXN0LnNvbG9waWRlLm1lIiwiY3VzdG9tZXJJZCI6IjY3MmUwNTA3MGIzMWVjZTJjOGUzOTE3YiIsInBlcm1pc3Npb25zIjpbImNhdGVnb3J5OnJlYWQiLCJjYXRlZ29yeTpidWxrIiwiY29tbWVyY2U6d3JpdGUiLCJjdXN0b21lcjpyZWFkIiwiZGlzY291bnQtbGltaXRzOnJlYWQiLCJkaXNjb3VudC1saW1pdHM6d3JpdGUiLCJkaXNjb3VudC1saW1pdHM6YnVsayIsImRpc2NvdW50LWxpbWl0czpkZXN0cm95IiwiZG9tYWluOnJlYWQiLCJkb21haW46YnVsayIsImdyb3VwOnJlYWQiLCJncm91cDp3cml0ZSIsImdyb3VwOmRlc3Ryb3kiLCJncm91cDpidWxrIiwiaW1wb3J0OndyaXRlIiwiaW50ZWdyYXRpb24taW5mbzpyZWFkIiwiaW50ZWdyYXRpb24taW5mbzp3cml0ZSIsIm9yZGVyOnJTpyZWFkIiwib3ZlcnJpZGU6d3JpdGUiLCJvdmVycmlkZTpidWxrIiwicGF5bWVudDpyZWFkIiwicGVuZGluZy1kb2N1bWVudDpidWxrIiwicHJvbW90aW9uOnJlYWQiLCJwcm9tb3Rpb246d3JpdGUiLCJwcm9tb3Rpb246YnVsayIsInNhbGVzbWFuOnJlYWQiLCJzYWxlc21hbjp3cml0ZSIsInNhbGVzbWFuOmJ1bGsiLCJzZWdtZW50OnJlYWQiLCJzZWdtZW50OndyaXRlIiwic2VnbWVudDpidWxrIiwic2VnbWVudDpidWxrLWRlc3Ryb3kiLCJzZWxsZXI6cmVhZCIsInNlbGxlcjpidWxrIiwic2t1OnJlYWQiLCJza3U6YnVsayIsInN1cGVydmlzb3I6YnVsayIsInN0b3JlOnJlYWQiLCJzdWdnZXN0aW9uOnJlYWQiLCJzdWdnZXN0aW9uOmJ1bGsiLCJ1cGxvYWRlcjpyZWFkIiwidXBsb2FkZXI6d3JpdGUiXSwidmVyaWZpZWQiOnRydWUsImJsb2NrZWQiOmZhbHNlLCJ0eXBlIjoiYXBwbGljYXRpb24iLCJjb25uZWN0aW9uSWQiOiI2N2M3MWZhNmU1NzcyMmY2NGU3NjdiZDYiLCJpYXQiOjE3NDExMTI4NjksImV4cCI6MTc0MTExMzc2OX0.lTklbBucJ6o-CFAdSGeO5rfJM-VUmw_xEbQVdoIaUKE",
	"token_type": "bearer",
	"expires_in": 900
}

🔒 Autenticação e segurança da API do cliente

Os endpoints devem estar protegidos por um dos seguintes mecanismos de autenticação para garantir a segurança dos dados:

API Token 🔑

📋 Formato de dados

As solicitações de Webhook enviadas pela YOM estarão no formato JSON. Recomenda-se utilizar UTF-8 em todas as respostas.

Exemplo de payload: