Skip to content

Commit 4a98d1d

Browse files
committed
Some fixes
1 parent 2977741 commit 4a98d1d

File tree

2 files changed

+37
-35
lines changed

2 files changed

+37
-35
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,4 @@ go.work
2525
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
2626
# and can be added to the global gitignore or merged into this file. For a more nuclear
2727
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
28-
.idea/
28+
.idea/

README.md

Lines changed: 36 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,27 @@
11
# whatsapp-api-webhook-server-golang
22

3-
whatsapp-api-webhook-server-golang - библиотека на Go, созданная для интеграции с WhatsApp через API
4-
сервиса [GREEN API](https://green-api.com/). Чтобы начать использовать библиотеку, вам нужно получить ID и token
5-
аккаунта в [личном кабинете](https://console.green-api.com/).
3+
whatsapp-api-webhook-server-golang - библиотека для интеграции с мессенджером WhatsApp через API
4+
сервиса [green-api.com](https://green-api.com/). Чтобы воспользоваться библиотекой, нужно получить регистрационный токен
5+
и ID аккаунта в [личном кабинете](https://console.green-api.com/). Есть бесплатный тариф аккаунта разработчика.
66

77
## API
88

9-
Документация к REST API находится [здесь](https://green-api.com/docs/api/). Библиотека является оберткой к REST API,
9+
Документация к REST API находится по [ссылке](https://green-api.com/docs/api/). Библиотека является оберткой к REST API,
1010
поэтому документация по ссылке выше применима и к самой библиотеке.
1111

12-
## Подготовка среды
12+
## Авторизация
1313

14-
На сервере должен быть установлен Go. Установить Go можно так:
14+
Чтобы отправить сообщение или выполнить другие методы Green API, аккаунт WhatsApp в приложении телефона должен быть в
15+
авторизованном состоянии. Для авторизации аккаунта перейдите в [личный кабинет](https://console.green-api.com/) и
16+
сканируйте QR-код с использованием приложения WhatsApp.
1517

16-
```shell
17-
snap install go --classic
18-
```
18+
## Пример подготовки среды для Ubuntu Server
1919

20-
Проверьте, что вы установили Go:
20+
### Установка Go
2121

22-
```shell
23-
go version
24-
```
22+
На сервере должен быть установлен Go. [Инструкция по установке Go](https://go.dev/doc/install).
2523

26-
### Пример подготовки среды на Ubuntu Server
24+
### Обновление системы
2725

2826
Обновим систему:
2927

@@ -32,6 +30,8 @@ sudo apt update
3230
sudo apt upgrade -y
3331
```
3432

33+
### Брандмауэр
34+
3535
Настроим брандмауэр:
3636

3737
Разрешим соединение по SSH:
@@ -60,34 +60,22 @@ sudo ufw allow https
6060
sudo ufw enable
6161
```
6262

63-
## Как перенаправить входящие уведомления на сервер
64-
65-
Чтобы перенаправить входящие уведомления на сервер, нужно в личном кабинете установить адрес отправки уведомлений (URL).
63+
## Как запустить веб-сервер
6664

67-
![](https://raw.githubusercontent.com/green-api/whatsapp-api-webhook-server-python/master/media/ChangeWebhookServerURL.png)
65+
### Установка
6866

69-
## Установка
67+
Не забудьте создать модуль:
7068

7169
```shell
72-
go get github.com/green-api/whatsapp-api-webhook-server-golang
70+
go mod init example
7371
```
7472

75-
### Установка и запуск примера
76-
7773
Установка:
7874

7975
```shell
80-
wget https://raw.githubusercontent.com/green-api/whatsapp-api-webhook-server-golang/master/examples/main.go
81-
```
82-
83-
Запуск:
84-
85-
```shell
86-
go run main.go
76+
go get github.com/green-api/whatsapp-api-webhook-server-golang
8777
```
8878

89-
## Пример
90-
9179
### Импорт
9280

9381
```
@@ -96,7 +84,9 @@ import (
9684
)
9785
```
9886

99-
### Как инициализировать объект
87+
### Примеры
88+
89+
#### Как инициализировать объект
10090

10191
Атрибут WebhookToken является опциональным.
10292

@@ -107,17 +97,29 @@ webhook := pkg.Webhook{
10797
}
10898
```
10999

110-
### Запуск сервера
100+
#### Как запустить веб-сервер
111101

112102
Функция StartServer принимает функцию-обработчик. Функция-обработчик должна содержать 1
113103
параметр (`body map[string]interface{}`). При получении нового уведомления ваша функция-обработчик будет выполнена.
114104

105+
Ссылка на пример: [main.go](examples/main.go).
106+
115107
```
116108
_ := webhook.StartServer(func(body map[string]interface{}) {
117109
fmt.Println(body)
118110
})
119111
```
120112

113+
### Запуск приложения
114+
115+
```shell
116+
go run main.go
117+
```
118+
119+
## Документация по методам сервиса
120+
121+
[Документация по методам сервиса](https://green-api.com/docs/api/)
122+
121123
## Лицензия
122124

123-
Лицензия MIT. [LICENSE](LICENSE)
125+
Лицензировано на условиях MIT. Смотрите файл [LICENSE](LICENSE).

0 commit comments

Comments
 (0)