logoNaty

Versão: V1

Introdução Naty API Oficial Meta

Olá, Seja bem vindo!

Nossa API de integração com a api oficial do whatsapp foi criada para facilitar a utilização e integrar a sistemas utilizando eventos, todos os webhooks de comunicação com a api oficial do facebook serão facilitados.

Instalação

Para usar o Naty API no seu projeto, basta executar os seguintes comandos:

npm i @natyapp/meta

Utilização

Precisará de um token fornecido pela equipe do Secretaria Naty e adicionar ao header como x-access-token e aplicá-lo ao endpoint principal em suas requests.

Endpoint Principal:



https://whatsapi.secretarianaty.com/v1

Eventos

Webhooks

Adicionar Webhook

POST
/webhook

Utilize este endpoint para adicionar um webhook novo de comunicação com a nossa api.


Visualizar Webhook

GET
/webhook/:id

Utilize este endpoint para visualizar um webhook utilizando o id como parâmetro.


Visualizar Webhooks

GET
/webhook

Utilize este endpoint para visualizar todos os webhooks registrados.


Atualizar Webhook

PATCH
/webhook/:id

Utilize este endpoint para atualizar um webhook pelo id.


Remover Webhook

DELETE
/webhook/:id

Utilize este endpoint para remover um webhook pelo id.


Conexões

Adicionar Conexão

POST
/connections

Utilize este endpoint para adicionar um connections novo de comunicação com a nossa api.


Visualizar Conexão

GET
/connections/:id

Utilize este endpoint para visualizar uma conexão.


Visualizar Conexões

GET
/connections

Utilize este endpoint para visualizar todas as conexões utilizando a query para paginação.


Atualizar Conexão

PATCH
/connections/:id

Utilize este endpoint para atualizar a conexão.


Remover Conexão

DELETE
/connections/:id

Utilize este endpoint para remover uma conexão utilziando id como parâmetro.


Logs

Visualizar Webhook

GET
/webhook/:id

Utilize este endpoint para visualizar um webhook utilizando o id como parâmetro.


Visualizar Webhooks

GET
/webhook

Utilize este endpoint para visualizar todos os webhooks utilizando paginação por query params.