API
Введение
Документ содержит описание программного интерфейса к сервису приватных заметок PrivNote (далее — API). API обеспечивает автоматизированный обмен данными с сервисом. С помощью API внешние приложения могут создавать приватные записки и загружать самоуничтожаемые файлы.
Для получения доступа к API необходимо отправить запрос с описанием отрасли и методов использования API. После вы получите API-ключ, который необходим для взаимодействия с сервисом.
Интеграция
Все запросы к API осуществляются по адресу https://privnote.ru/api/_VERSION_/. Вместо переменной _VERSION_ указывается версия используемого API. Актуальная версия API - 1.0. Тем самым, взаимодействие происходит с адресом https://privnote.ru/api/1.0/. Ниже приведен список параметров и их обозначения.
Все запросы к интерфейсу могут быть осуществлены посредством POST и GET запросов. Результат передается в формате JSON.
Параметры
| Переменная | Описание | Значения |
| ver Обязательно | Версия используемого API | double |
| note Обязательно | Текст записки без HTML тегов. Допускается использовать plain перенос строки. | string, [3,2048] |
| lang Default: en | Язык интерфейса взаимодействия | string, [ru, en] |
| confirm Default: 0 | Выводить предупредительное окно перед прочтением и уничтожением сообщения? | integer, [0, 1] |
| name Default: NULL | Индивидуальное название записки. | string, [3-32] |
| destructs Default: 0 | Метод самоуничтожения записки. 0 - сразу после прочтения. Другие значения указывают время в часах с момента создания записки. | int, [0, 1, 3, 24, 168, 720] |
| password Default: NULL | Собственный пароль для шифрования записки. Минимальная длина 6 символов. | string, [6-32] |
| email Default: NULL | Адрес электронной почты для уведомления после уничтожения записки | string, [6-32] |
Пример правильного запроса к интерфейсу:
https://privnote.ru/api/1.0/?note=test&key=Mz8KEY &lang=en&confirm=1
Ответ:
{"status":1,"message":"Note link ready! ","url":"https://privnote.ru/en/n/ kqCuFoi33#NkAlqf029d6"}
Описание ошибок
| Код | Название | Пояснение |
| 101 | Note is empty | Параметр текста заметки пустой |
| 102 | Invalid E-mail | Неверный формат E-mail |
| 103 | Password is too simple | Пароль слишком простой |
| 104 | Name is too long | Название заметки слишком длинное |
| 105 | Name is too short | Название заметки слишком короткое |
| 106 | Note is too short | Текст заметки слишком короткий |
| 107 | Note is too long | Текст заметки больше допустимого |
| 108 | Reached max requests per sec | Достигнуто максимальное количество запросов в секунду |
| 109 | API Key not specified | API ключ не указан |
| 110 | Invalid API Key | Неверный API ключ |