Документация <Fh/>

Работать с сервисом действительно очень просто. Убедитесь сами!


Начало работы

Основные принципы 1. Сервис не требует регистрации и мы не просим вас указывать какие-либо контактные данные.
2. Мы сохраняем данные ваших форм, которые вы можете разместить на любых удобных вам платформах.
3. Для получения сохраненных данных необходимо сделать запрос к нашему API любым удобным для вас способом.

С чего начать? Для работы с сервисом вам понадобятся:
1. HTML форма. Создайте форму и разместите ее на любом ресурсе в сети. Все, что вам потребуется это указать в ней наш action.
2. OPEN-KEY - открытый ключ для отправки форм.
3. SECRET-KEY - секретный ключ получения сохраненных данных с помощью API.

        
        <form action="https://formhub.dev/io/OPEN-KEY" method="POST">
        
        

Важно Ключи невозможно восстановить! Не теряйте их!

Очень важно Никому не сообщайте ваш секретный ключ. Зная его можно получить все ваши сохраненные данные.

Храните секретный ключ в надежном месте.



Получить ключи


Простая формы с редиректом на ваш сервер:

Укажите ваш открытый ключ и URL-адрес на вашем сервере, на который пользователь будет перенаправлен после отправки формы.

Важно Поле для указания адреса перенаправления не является обязательным. Если его не будет в форме, то после отправки данных пользователь увидит стандартную страницу уведомления FormHub.

    
    <form action="https://formhub.dev/io/OPEN-KEY" method="POST">
    <input type="email" name="email" value="example@email.com">
    <input type="text" name="name" value="John Doe">
    <input type="hidden" name="redirect-to" value="YOUR-SERVER-PAGE">
    <button type="submit">Send</button>
    </form>
    
    
Пример формы с отправкой на JS:

Важно Обязательно укажите значение no-redirect в поле redirect-to. Сервер ответит текстом OK в случае успеха или сообщением об ошибке.

    
    <form id="my-form">
    <input type="email" name="email" value="example@email.com">
    <input type="text" name="name" value="John Doe">
    // это поле обязательное для обработки формы на JS
    <input type="hidden" name="redirect-to" value="no-redirect">
    <button type="button" id="submit-button">Send</button>
    </form>
    

Добавьте в код вашей страницы обработчик клика по кнопке Send.

    
    <script>
        document.getElementById('submit-button').addEventListener('click',
        async function(event) {
            const form = document.getElementById('my-form');
            const formData = new FormData(form);
            const url = 'https://formhub.dev/io/OPEN-KEY'; // ВАШ ОТКРЫТЫЙ КЛЮЧ

            try {
                // Отправляем POST запрос с помощью fetch
                const response = await fetch(url, {
                    method: 'POST',
                    body: formData
                });

                // Проверяем успешность ответа
                if (response.ok) {
                    const result = await response.text();
                    if (result === 'OK') {
                        console.log('Ок');
                    }
                    else {
                        console.log('Сервер сообщил об ошибке: ' + result);
                    }
                } else {
                    console.error('Ошибка при отправке:',
                        response.status, response.statusText);
                }
            } catch (error) {
                console.error('Сетевая ошибка:', error);
            }
        });
    </script>
    
Загрузка файлов

Важно Возможные типы загружаемых файлов: jpg, jpeg, png, pdf
Максимальный размер файла: 5 Мегабайт.

    
    <input type="file" name="user-cv" accept="image/jpeg, image/png, application/pdf">
    <input type="file" name="user-photo" accept="image/jpeg, image/png">
    
    

Очень важно Мы не поддерживаем формы с мультивыбором файлов!
Каждый загружаемый файл должен быть представлен отдельным полем формы с уникальным параметром name!



Получение сохраненных данных:

Важно Данные можно получить с помощью API в JSON формате. Вам необходимо передавать в заголовке запроса ваш секретный ключ во всех вызовах API.

Доступные методы 1. https://formhub.dev/io/getFormsCount - GET
Метод позволяет получить количество сохраненных форм. Не требует дополнительных параметров.

2. https://formhub.dev/io/getFormsData - GET
Метод позволяет получить данные сохраненных форм. Максимальное количество возвращаемых в одном ответе записей - 100.
Для указания диапазона выбора записей принимает два параметра:
 integer limit - по умолчанию 100 - сколько записей показать в ответе.
 integer offset - по умолчанию 0 - с какой записи начинать отбор данных для ответа. Оба параметра не являются обязательными и по умолчанию их значения всегда limit = 100, offset = 0

3. https://formhub.dev/io/getOneFormData - GET
Метод позволяет получить данные одной формы по идентификатору операции.
Принимает один параметр:
 integer operationId - уникальный идентификатор сохраненной формы

    
        #получение количества сохраненных форм
    curl "https://formhub.dev/io/getFormsCount" \
      -H "Authorization: SECRET-KEY"
    
    
    
        #получение 100 последних форм
    curl "https://formhub.dev/io/getFormsData?limit=100&offset=0" \
      -H "Authorization:SECRET-KEY"
    
    
    
        #получение 100 последних форм
    curl "https://formhub.dev/io/getOneForsData?operationId=ID" \
      -H "Authorization:SECRET-KEY"
    
    
Посмотрите примеры Python кода в Google Colab

Вы также можете использовать любой REST API клиент для получения данных. Например, Arc или Postman



Получить ключи