Создавайте записки, которые будут
самоуничтожены после прочтения
ru

API

Введение

Документ содержит описание программного интерфейса к сервису приватных заметок Privatty (далее — API). API обеспечивает автоматизированный обмен данными с сервисом. С помощью API внешние приложения могут создавать приватные записки и загружать самоуничтожаемые файлы.

Для получения доступа к API необходимо отправить запрос с описанием отрасли и методов использования API. После вы получите API-ключ, который необходим для взаимодействия с сервисом.

Интеграция

Все запросы к API осуществляются по адресу https://privatty.com/api/_VERSION_/. Вместо переменной _VERSION_ указывается версия используемого API. Актуальная версия API - 1.0. Тем самым, взаимодействие происходит с адресом https://privatty.com/api/1.0/. Ниже приведен список параметров и их обозначения.

Все запросы к интерфейсу могут быть осуществлены посредством POST и GET запросов. Результат передается в формате JSON.

Параметры

ПеременнаяОписаниеЗначения
ver
Обязательно
Версия используемого APIdouble
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://privatty.com/api/1.0/?note=test&key=Mz8KEY &lang=en&confirm=1
Ответ:
{"status":1,"message":"Note link ready! ","url":"https://privatty.com/en/n/ kqCuFoi33#NkAlqf029d6"}

Описание ошибок

КодНазваниеПояснение
101Note is emptyПараметр текста заметки пустой
102Invalid E-mailНеверный формат E-mail
103Password is too simpleПароль слишком простой
104Name is too longНазвание заметки слишком длинное
105Name is too shortНазвание заметки слишком короткое
106Note is too shortТекст заметки слишком короткий
107Note is too longТекст заметки больше допустимого
108Reached max requests per secДостигнуто максимальное количество запросов в секунду
109API Key not specifiedAPI ключ не указан
110Invalid API KeyНеверный API ключ

Your browser is out of date!

Please download the latest version of Internet Explorer
We recommend to use another modern browser!

Сменить язык