Начало работы
Аутентификация
Как создать API ключ и использовать его для доступа к API
Все запросы к CRM API требуют аутентификации через API ключ. Ключ идентифицирует ваше агентство и определяет, к каким данным у вас есть доступ.
Создайте API ключ
- Войдите на rentix.md (или staging.rentix.md для тестирования)
- Откройте Меню пользователя → [Название агентства] → API Ключи
- Нажмите Создать ключ
- Скопируйте ключ — он показывается только один раз
Храните ключ в безопасности. Любой, кто имеет ключ, может управлять объявлениями вашего агентства. Не коммитьте ключи в git и не передавайте третьим лицам.
Используйте ключ в запросах
Передавайте ключ в заголовке Authorization каждого запроса.
const response = await fetch('https://crm.rentix.md/api/v1/agency', {
headers: {
'Authorization': 'ApiKey YOUR_API_KEY'
}
});
const agency = await response.json();
console.log(agency.name); // "Ваше Агентство"
curl https://crm.rentix.md/api/v1/agency \
-H "Authorization: ApiKey YOUR_API_KEY"
$ch = curl_init('https://crm.rentix.md/api/v1/agency');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: ApiKey YOUR_API_KEY'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
$agency = json_decode($response, true);
echo $agency['name']; // "Ваше Агентство"
Альтернативный заголовок
Вместо Authorization можно использовать X-API-Key:
curl https://crm.rentix.md/api/v1/agency \
-H "X-API-Key: YOUR_API_KEY"
Проверьте подключение
Запрос к /agency — простой способ убедиться, что ключ работает.
Успешный ответ
{
"id": 1,
"name": "Ваше Агентство",
"status": "active",
"isCrmEnabled": true,
"limits": {
"monthlyListings": { "used": 5, "limit": 1000 }
}
}
Ошибки аутентификации
| Код | Ошибка | Решение |
|---|---|---|
| 400 | Multiple authentication methods provided | Используйте либо Authorization, либо X-API-Key, но не оба |
| 401 | API key is required | Добавьте заголовок Authorization: ApiKey YOUR_KEY |
| 401 | Invalid API key | Проверьте правильность API ключа и что он не отозван |
| 403 | Agency is suspended | Свяжитесь с поддержкой — аккаунт агентства приостановлен |
| 403 | CRM is not enabled for this agency | Свяжитесь с поддержкой для подключения CRM |
Следующий шаг
Ключ готов — создайте первое объявление.