Go-CRM API — Быстрый старт

Эта инструкция поможет вам:

• подключиться к API Go-CRM (официальная документация https://docs.go-crm.ru);
• авторизоваться;
• получить доступ к данным;
• избежать типичных ошибок.

Если вы делаете интеграцию впервые — идите строго по шагам.

1. Что нужно перед началом

У вас должно быть:

• адрес вашей системы
  https://ваш-домен
• APP-TOKEN (выдается в системе по адресу: https://ваш-домен/applications/keys)
• номер телефона клиента (логин)
• пароль клиента

Важно

• Пароль отправляется клиенту в мессенджер
• Мессенджер должен быть подключен
• Телефон должен совпадать с главным номером клиента в CRM

2. Как работать с API (2 сценария)

Сценарий A — клиент уже есть в CRM

Используйте этот вариант в 80% случаев
Шаги:

1. Берете телефон клиента
2. Берете пароль клиента
3. Делаете запрос /auth/login
4. Получаете accessToken и refreshToken
5. Работаете с API

Сценарий B — клиента еще нет

Шаги:

1. Отправляете /auth/registration
2. В CRM появляется лид
3. Вручную переводите лида в клиента
4. В карточке клиента находите пароль
5. Делаете /auth/login
6. Получаете токены

Частая ошибка

Регистрация ≠ готовый клиент (после регистрации в системе появляется Лид - заявка, ее нужно обработать. Администратору нужно познакомиться с новым клиентом и превратить заявку в клиента)
После /registration обязательно:
→ администратор должен вручную перевести лида (заявку) в клиента
→ получить пароль

3. Авторизация (получение токенов)

URL

POST /api/v3/auth/login

Заголовки

APP-TOKEN: ваш_APP_TOKEN

Тело запроса

{
"person": "client",
"login": "79111111112",
"password": "12345",
"fcmToken": ""
}

Пример cURL

curl -X POST "https://ваш-домен/api/v3/auth/login" \
-H "APP-TOKEN: ваш_APP_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"person": "client",
"login": "791111111111",
"password": "12345",
"fcmToken": ""
}'

Ответ

{
"status": "success",
"data": {
"accessToken": "xxx",
"refreshToken": "yyy"
}
}

4. Как работают токены

accessToken

• действует ~10 минут
• используется для всех запросов

refreshToken

• нужен для обновления accessToken

Главное правило

После обновления токенов:
старые токены → удалить
новые токены → сохранить

5. Обновление токена

URL

POST /api/v3/auth/refresh

Тело запроса

{
"person": "client",
"refresh": "ваш_refresh_token",
"fcmToken": ""
}

Пример cURL

curl -X POST "https://ваш-домен/api/v3/auth/refresh" \
-H "APP-TOKEN: ваш_APP_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"person": "client",
"refresh": "ваш_refresh_token",
"fcmToken": ""
}'

6. Вызов любого метода API

Обязательные заголовки

APP-TOKEN: ваш_APP_TOKEN
Authorization: Bearer accessToken

7. Пример запроса — получение часов

Метод

GET /api/v3/hours

Параметры

Пример cURL

curl -X GET "https://ваш-домен/api/v3/hours?center=3&dateStart=2024-12-01%2000:00:00&dateEnd=2024-12-01%2023:59:59" \
-H "APP-TOKEN: ваш_APP_TOKEN" \
-H "Authorization: Bearer ваш_accessToken"

8. Регистрация клиента

URL

POST /api/v3/auth/registration

Пример cURL

curl -X POST "https://ваш-домен/api/v3/auth/registration" \
-H "APP-TOKEN: ваш_APP_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"phone": "791111111111",
"name": "Иван"
}'

Что происходит дальше

1. Создается лид
2. Нужно вручную:
   • зарегистрировать клиента
   • открыть карточку
   • найти пароль в сообщениях

9. Частые ошибки

Ошибка 401 / не работает API

Причина:

• нет Authorization заголовка

Ошибка авторизации через 10 минут

Причина:

• истек accessToken
  Решение:
  → использовать /auth/refresh

refresh перестал работать

Причина:

• не сохранен новый refreshToken

клиент не может войти

Причина:

• номер не главный в карточке

пароль не приходит

Причина:

• не подключен мессенджер

10. Минимальный алгоритм (самое главное)

1. login → получить access + refresh
2. сохранить токены
3. делать API запросы
4. access истек → refresh
5. сохранить новые токены

11. Нужно запомнить

• не используйте registration без необходимости
• accessToken живет мало
• refreshToken всегда обновляется
• всегда передавайте 2 заголовка