## O que é
Uma integração simplesmente fantástica para ligar a sua conta Aftership ao seu Botpress Bot. Acompanhe os envios em tempo real e notifique os utilizadores diretamente através do seu bot quando ocorrerem actualizações.
Como funciona
Ao ativar a integração, é configurada uma subscrição Webhook para a sua conta Aftership utilizando a API Key
fornecida. Este webhook envia actualizações para a integração sempre que houver uma alteração significativa no estado de seguimento de um envio.
A ação Track Shipment
pode ser utilizada para iniciar o seguimento de um envio. Requer um Tracking Number
e utiliza a API da Aftership para obter e monitorizar o estado da expedição, incorporando um Conversation Id
único nos dados de seguimento. Este Id é então usado para ativar o Aftership Event
dentro da conversa, permitindo que o seu bot responda às actualizações de envio.
O Conversation Id
é um identificador único para cada conversa. Você pode passar neste campo para incorporar seu ID. Quando receber uma atualização de envio, pode utilizar
no campo Conversation ID
das Opções Avançadas do Acionador de Eventos de Envio
. Isto direcciona a atualização para a conversa apropriada.
Pode ver o código de integração completo na página Git do Simply Great Bots: Aftership Repo
Configuração do Aftership
Pré-requisito
Você deve ter um plano Aftership Pro ou superior para receber eventos webhook para rastreamento.
Obtendo a chave da API
- Aceda ao Painel de controlo do administrador da Aftership.
- Navegue até
Desenvolvedores
-> Chaves de API
.
- Clique em
Create API Key
, dê um nome à sua chave e seleccione Save
.
- Copie e cole a sua chave API num local seguro, pois irá precisar dela durante a configuração do Botpress .
Webhook e Segredo
- Navegue até Tracking Dashboard -> Notifications -> Webhooks.
- Copie o seu Webhook Secret e cole-o num local seguro. Irá precisar dele durante a configuração de Botpress .
- Clique em
Adicionar Webhook
.
- Defina a versão do webhook para o padrão "Legacy".
- Cole o URL Webhook da sua integração Botpress Aftership no campo
Webhook URL
.
- Salve as configurações de webhook .
Configuração de Botpress
- Copie e cole a sua chave API do Aftership da Configuração do Aftership no campo
Chave API
.
- Copie e cole o seu
Webhook Secret
da Configuração do Aftership no seu campo Secret
.
## O que é
Uma integração simplesmente fantástica para ligar a sua conta Aftership ao seu Botpress Bot. Acompanhe os envios em tempo real e notifique os utilizadores diretamente através do seu bot quando ocorrerem actualizações.
## Como funciona
Ao ativar a integração, é configurada uma subscrição Webhook para a sua conta Aftership utilizando a `API Key` fornecida. Este webhook envia actualizações para a integração sempre que houver uma alteração significativa no estado de seguimento de um envio.
A ação `Track Shipment` pode ser utilizada para iniciar o seguimento de um envio. Requer um `Tracking Number` e utiliza a API da Aftership para obter e monitorizar o estado da expedição, incorporando um `Conversation Id` único nos dados de seguimento. Este Id é então usado para ativar o `Aftership Event` dentro da conversa, permitindo que o seu bot responda às actualizações de envio.
O `Conversation Id` é um identificador único para cada conversa. Você pode passar `` neste campo para incorporar seu ID. Quando receber uma atualização de envio, pode utilizar `` no campo `Conversation ID` das Opções Avançadas do `Acionador de Eventos de Envio`. Isto direcciona a atualização para a conversa apropriada.
Pode ver o código de integração completo na página Git do Simply Great Bots: [Aftership Repo](https://github.com/SimplyGreatBots/aftership)
### Configuração do Aftership
#### Pré-requisito
Você deve ter um plano Aftership Pro ou superior para receber eventos webhook para rastreamento.
#### Obtendo a chave da API
1. Aceda ao [Painel de controlo do administrador da Aftership] (https://admin.aftership.com/).
2. Navegue até `Desenvolvedores` -> `Chaves de API`.
3. Clique em `Create API Key`, dê um nome à sua chave e seleccione `Save`.
4. Copie e cole a sua chave API num local seguro, pois irá precisar dela durante a configuração do Botpress .
#### Webhook e Segredo
1. Navegue até [Tracking Dashboard -> Notifications -> Webhooks] (https://admin.aftership.com/notifications/webhooks#).
2. Copie o seu Webhook Secret e cole-o num local seguro. Irá precisar dele durante a configuração de Botpress .
3. Clique em `Adicionar Webhook`.
4. Defina a versão do webhook para o padrão "Legacy".
5. Cole o URL Webhook da sua integração Botpress Aftership no campo `Webhook URL`.
6. Salve as configurações de webhook .
### Configuração de Botpress
1. Copie e cole a sua chave API do Aftership da Configuração do Aftership no campo `Chave API`.
2. Copie e cole o seu `Webhook Secret` da Configuração do Aftership no seu campo `Secret`.