Начало работы с Sign.Plus API

Sign.Plus API позволяет разработчикам без труда встраивать защищённые, юридически значимые электронные подписи в свои приложения и веб-сайты. Такая интеграция обеспечивает удобный процесс подписания для пользователей прямо на их платформе.

Следуйте этому руководству, чтобы начать работу с Sign.Plus API:

Создайте учётную запись и перейдите на тариф API

Чтобы начать использовать Sign.Plus API, необходимо создать учётную запись и перейти на тарифный план API:

1. Перейдите на страницу https://www.sign.plus/api/pricing.

2. Выберите тариф, который подходит под ваши задачи, и создайте учётную запись.

Создайте персональный токен доступа

После перехода на новый тариф вам потребуется создать персональный токен доступа для работы с Sign.Plus API:

1. В разделе API найдите опцию создания нового персонального токена доступа.

2. Выберите области действия разрешений для вашего токена:
   sign:all:read: предоставляет доступ на чтение ресурсов (эндпоинты GET)
   sign:all:edit: предоставляет доступ на изменение ресурсов (эндпоинты POST, PUT, DELETE)

   Совет: вы можете выбрать обе области действия разрешений или только одну — в зависимости от ваших задач.

3. Установите срок действия токена.

   Совет: рекомендуем устанавливать срок действия 90 дней.

4. Создайте токен и сохраните его в надёжном месте. После этого шага повторно просмотреть его будет невозможно.
   

   Примечание: настройте напоминания о ротации ключей, чтобы обеспечить строгую безопасность доступа к API.

Проверка подключения к API

После получения персонального токена доступа необходимо убедиться, что всё работает корректно. Для взаимодействия с нашим API доступно несколько вариантов:

1. cURL
   Откройте терминал и выполните следующую команду:

   curl -I --location '<https://restapi.sign.plus/v2/envelopes>' \\
   --header 'Content-Type: application/json' \\
   --header 'Authorization: $PERSONAL_ACCESS_TOKEN' \\
   --data '{}'

   Замените $PERSONAL_ACCESS_TOKEN на токен, который вы сгенерировали ранее.

   Если вы получили код состояния 200 OK, поздравляем! Подключение к API работает корректно.
   
2. Postman
   

   • Откройте Postman и создайте новый запрос.

   • Установите тип запроса POST и введите URL-адрес эндпоинта API

     https://restapi.sign.plus/v2/envelopes
   • На вкладке Headers добавьте новый заголовок:
   • Key: Authorization
   • Value: Bearer $PERSONAL_ACCESS_TOKEN

   • Отправьте запрос и проверьте, что в ответе получен код состояния 200 OK. Поздравляем! Теперь вы готовы начать использовать API электронной подписи Sign.Plus в своих проектах.

Вот несколько следующих шагов и дополнительных ресурсов, которые помогут вам максимально эффективно использовать наш API:

Документация API

Подробную информацию об эндпоинтах API и расширенных возможностях вы найдёте в нашей исчерпывающей документации по API.

Бэкенд-SDK

Мы настоятельно рекомендуем использовать наши бэкенд-SDK (Установка — Sign.Plus API ), чтобы легко интегрировать электронную подпись Sign.Plus API в ваш бэкенд. Мы предлагаем SDK для следующих языков:

• Python
• TypeScript
• Go
• Java
• C#
• PHP
   

Использование этих SDK может значительно упростить процесс интеграции и позволит быстро начать работу.