Как подготовиться к интеграции с HostHub
Какие задачи описать разработчику и что сообщить при запросе доступа.
Интеграция проходит быстрее, если до обращения за доступом определить, что именно должна делать ваша система. Ниже — порядок подготовки, который сэкономит время и вам, и разработчику.
Опишите задачу обычными словами
Не нужно знать технические термины. Достаточно ответить на три вопроса: какие данные нужны, где вы хотите их видеть и как часто они должны обновляться. Например: «Раз в день получать список доменов со сроками действия и показывать его в нашей CRM».
Разделите просмотр и изменение
Права ключа доступа назначаются под задачу. Составьте два списка:
- только просмотр — домены и сроки, услуги хостинга, счета, цены доменных зон;
- изменение — DNS-записи, NS-серверы, регистрация и продление доменов.
Если системе достаточно читать данные, запрашивайте доступ только на просмотр: так безопаснее.
Что сообщить при запросе доступа
- аккаунт HostHub, для которого нужен ключ;
- перечень действий, которые будет выполнять программа;
- адреса серверов, с которых будут приходить запросы, если они постоянны;
- контакт разработчика или ответственного сотрудника.
Что передать разработчику
Описание задачи, документацию API и ключ доступа. Ключ передавайте по защищённому каналу, а не в общем чате или письме с открытым текстом — подробнее в статье «Как защитить ключ доступа к API».
Как проверить результат
- Начните с запросов на просмотр и сверьте ответ с тем, что видите в личном кабинете.
- Действия, которые что-то меняют, сначала проверьте на одном домене.
- Убедитесь, что система понятно сообщает об ошибках и не повторяет платные операции без подтверждения.
- При обращении в поддержку передавайте request_id — номер конкретного запроса из ответа API.
Запросить доступ можно на странице «API интеграция».