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

API в разработке. На текущий момент реализована работа с созданием и публикацией отправлений.

Отправления

Авторизация

Для всех обращений к апи требующих авторизацию (например, создание и публикация отправления) необходимп в параметрах url запроса добавить access-token пользователя и amail отправителя, от лица которых будет создано отправление.

Значение access-token пользователя можно посмотреть на странице вашего аккаунта в сервисе анатарус. Amail отправителя - на странице профиля отправителя (физ лица, ИП и др.) или на любой странице сверху справа, после авторизации на сайте).

Пример url:

https://api.anatarus.com/v2/<controller>/?access-token=<token>&amail=<aa999@anatarus.com>

Создание отправления

Для создания отправления (документа) необходимо выполнить POST запрос на url /v2/documents/ и передать необходимые параметры (перечень необходимых параметров указан в таблице ниже).

            
POST https://api.anatarus.com/v2/documents/?amail={amail}&access-token={token}
Content-Type: application/json

{
    "type":2,
    "recipient_type":0,
    "content": "Сообщение для получателя",
    "recipient_first_name":"Василий",
    "recipient_second_name":"Петрович",
    "recipient_last_name":"Гусев",
    "recipient_email":"gusev@example.ru",
    "public":1
}
            
        

Пример успешного результата

            
HTTP/1.1 201 Created
Date: Tue, 12 Feb 2019 05:24:46 GMT
Content-Type: application/json; charset=UTF-8
Location: https://api.anatarus.com/v2/documents/1/

{
  "id": 1,
  "type": 2,
  "content": "Сообщение для получателя",
  "public": 1,
  "recipient_type": 0,
  "recipient": "Гусев Василий Петрович",
  "recipient_inn": null,
  "recipient_ogrn": null,
  "recipient_ogrnip": null,
  "recipient_arn": null,
  "recipient_notary_license": null,
  "recipient_address": "",
  "recipient_email": "gusev@example.ru",
  "recipient_phone": "",
  "state": null,
  "created_at": 1549949409,
  "updated_at": null,
  "hash": null,
  "sent_at": null,
  "publication": null,
  "_links": {
    "self": {
      "href": "https://api.anatarus.com/v2/documents/1743/"
    },
    "attachments": {
      "href": "https://api.anatarus.com/v2/documents/1743/attachments/"
    }
  }
}
            
        

В случае неуспешной валидации переданных данных для создания отправления будет возвращен код ошибки 422, и дополнительная информация в теле ответа:

    
HTTP/1.1 422 Data Validation Failed.
Date: Tue, 12 Feb 2019 05:24:46 GMT
Content-Type: application/json; charset=UTF-8

[
  {
    "field": "recipient_type",
    "message": "Необходимо заполнить «Recipient Type»."
  },
  {
    "field": "recipient_last_name",
    "message": "Необходимо заполнить «Recipient Last Name, Recipient Second Name или Recipient First Name»."
  },
  ...
]
    

Таблица параметров отправления *

Атрибут	Значение	Комментарий
type	int	Тип отправления, допустимые значения: 9:Письмо, 0:Обращение, 1:Заявление, 2:Уведомление, 3:Требование, 4:Петиция, 5:Отзыв, 6:Жалоба, 7:Поздравление, 8:Фиксация факта, 10:Ответ, 11:Претензия,
content	string	текст отправления
public	boolean	Публикация данных отправителя и получателя в СМИ Анатарус. По умолчанию false
recipient_type	int	Тип получателя. 0:Физическое лицо, 1: Индивидуальный предприниматель, 2:Юридическое лицо, 3: Пользователь анатарус, 4: Отправитель, 5: Арбитражный управляющий, 6: Нотариус Важно: При указании типа отправления (type) равным 8 (фиксация факта), переданное значение типа получателя (recipient_type) заменяется на значение 4 (Отправитель)
recipient_name	string	Краткое наименование получателя с организационно провавой формой. Необходимо для типа получателя 2 (Юридическое лицо), игнорируется для других типов
recipient_first_name	string	Имя получателя. Необходимо для получателей: 0, 1, 5, 6. Игнорируется для остальных
recipient_second_name	string	Отчество получателя. Необходимо для получателей: 0, 1, 5, 6. Игнорируется для остальных
recipient_last_name	string	Фамилия получателя. Необходимо для получателей: 0, 1, 5, 6. Игнорируется для остальных
recipient_email	string	Email получателя. Необходимо для получателей: 0, 1, 2, 5, 6. Обязателен при создании отправления если не указан телефон и сообщение не публикуется в СМИ (public = 0)
recipient_phone	string	Email получателя. Необходимо для получателей: 0, 1, 2, 5, 6. Обязателен при создании отправления если не указан email и сообщение не публикуется в СМИ (public = 0)
recipient_phone	string	Email получателя. Необходимо для получателей: 0, 1, 2, 5, 6. Обязателен при создании отправления если не указан email и сообщение не публикуется в СМИ (public = 0)
recipient_address	string	Адрес получателя (юридический или почтовый). Для физического лица (recipient_type=0) обязателен если отправление публикуется в СМИ и не указывается email и телефон. Для индивидуального предпринимателя (1) обязателен если не указывается ИНН и ОГРНИП. Для юридического лица (2) обязателен если отправление публикуется в СМИ и не указывается ИНН и ОГРН. Для нотариуса (6) не обязательно.
recipient_inn	string	ИНН получателя. Для индивидуального предпринимателя (1) обязателен если не указывается адрес и ОГРНИП. Для юридического лица (2) обязателен если отправление публикуется в СМИ и не указывается адрес и ОГРН или без публикации в СМИ: если не указан ОГРН. Для арбитражного управляющего (5) обязательно если не указывается реестровый номер.
recipient_ogrn	string	ОГРН получателя. Для юридического лица (2) обязателен если отправление публикуется в СМИ и не указывается адрес и инн или без публикации в СМИ: если не указан ИНН.
recipient_ogrnip	string	ОГРНИП получателя. Для индивидуального предпринимателя (1) обязателен если не указывается адрес или ИНН.
recipient_arn	string	ОГРНИП получателя. Для арбитражного управляющего (5) обязателен если не указывается ИНН.
recipient_notary_license	string	Номер лицензии нотариуса (6) обязателен при отпавлении нотариусу

API все еще находится в разработке и набор обязательных атрибутов для создания отправления может измениться.

Добавление вложений

Для прикрепления вложения к созданному но еще не опубликованному отправлению необходимо выполнить POST (multipart/form-data) запрос

            
POST https://api.anatarus.com/v2/documents/{document_id}/attachments/?amail={amail}&access-token={token}
Content-Type: multipart/form-data; boundary=WebAppBoundary

--WebAppBoundary
Content-Disposition: form-data; name="file" filename="file.txt"

< ./test.file
--WebAppBoundary
            
        

Где {document_id} это параметр id созданной по примеру выше публикации.

Пример успешного результата

            
HTTP/1.1 201 Created
Date: Tue, 12 Feb 2019 05:24:46 GMT
Content-Type: application/json; charset=UTF-8
Location: https://api.anatarus.com/v2/documents/111/attachments/1

{
    "id":1,
    "document_id":111,
    "sender_id":"1",
    "name":"test.file",
    "mime_type":"text/plain",
    "filesize":2010,
    "hash":"f47d9c16bcd0c707034f7661319c6f60e408c1ee58cb2cdb8c4563c2218937c3",
    "filename":"ehmAMag1SH29nPXJP8PMuqYYezZD3XAa",
    "created_at":1550215679,
    "updated_at":1550215679
}
            
        

В случае неуспешного выполнения вы получите ответ с кодом 422 (с указанием причины)

Публикация

Для публикации созданного отправления необходимо последовательно выполнить два запроса GET и POST на ресурс /v2/documents/{document_id}/publish

            
GET https://api.anatarus.com/v2/documents/{document_id}/publish/?amail={amail}&access-token={token}
Accept: application/json
            
        

Успешным запросом на GET запрос вы инициируете отправку СМС кода на номер телефона пользователя, от чьего имени происходит публикация. Данные код нужно отправить в теле POST запроса по этому же адресу:

            
POST https://api.anatarus.com/v2/documents/{document_id}/publish/?amail={amail}&access-token={token}
Content-Type: application/json

{
  "code":111111
}
            
        

В результате будет получен успешный ответ с кодом 200 и параметры опубликованного отправления.

            
HTTP/1.1 200 OK
Date: Fri, 15 Feb 2019 07:48:01 GMT
Content-Type: application/json; charset=UTF-8
{
  "id": 111,
  "type": 2,
  "content": "Сообщение для получателя",
  "public": 1,
  "recipient_type": 0,
  "recipient": "Гусев Василий Петрович",
  "recipient_inn": null,
  "recipient_ogrn": null,
  "recipient_ogrnip": null,
  "recipient_arn": null,
  "recipient_notary_license": null,
  "recipient_address": "",
  "recipient_email": "gusev@example.ru",
  "recipient_phone": "",
  "state": null,
  "created_at": 1549949409,
  "hash": "d58ba34b1d26c156094efdd5cca2ec05d523327a7991cc32694c942a10538710",
  "sent_at": 1549771512,
  "publication": {
    "id": 1727,
    "name": "",
    "created_at": 1549771512,
    "views": 0,
    "url": "https://anatarus.com/p/1727/"
  },
  "_links": {
    "self": {
      "href": "https://api.anatarus.com/v2/documents/111/"
    },
    "attachments": {
      "href": "https://api.anatarus.com/v2/documents/111/attachments/"
    }
  }
}