https://github.com/virenbar/pochtaapi

Библиотека для работы с API Почты России
https://github.com/virenbar/pochtaapi

api-client mailing pochtaru russian-post russianpost

Last synced: about 1 month ago
JSON representation

Библиотека для работы с API Почты России

• Host: GitHub
• URL: https://github.com/virenbar/pochtaapi
• Owner: Virenbar
• License: mit
• Created: 2021-06-18T06:36:09.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-01-17T08:30:39.000Z (almost 2 years ago)
• Last Synced: 2024-11-08T00:25:49.393Z (about 2 months ago)
• Topics: api-client, mailing, pochtaru, russian-post, russianpost
• Language: C#
• Homepage: https://virenbar.ru/PochtaAPI/
• Size: 873 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# PochtaAPI [![Build artifact](https://github.com/Virenbar/PochtaAPI/actions/workflows/build-artifact.yml/badge.svg)](https://github.com/Virenbar/PochtaAPI/actions/workflows/build-artifact.yml) [![Nuget](https://img.shields.io/nuget/v/Virenbar.PochtaAPI)](https://www.nuget.org/packages/Virenbar.PochtaAPI/) [![Virenbar.PochtaAPI on fuget.org](https://www.fuget.org/packages/Virenbar.PochtaAPI/badge.svg)](https://www.fuget.org/packages/Virenbar.PochtaAPI)

Библиотека для работы с [API Почты России](https://www.pochta.ru/support/business/api)

## Аутентификация

Для использования сервисов Почты России, необходимы аутентификационные данные.  

- [Логин и пароль](https://tracking.pochta.ru/access-settings) для трекинга

- [Токен](https://otpravka.pochta.ru/specification#/authorization-token) и [ключ](https://otpravka.pochta.ru/specification#/authorization-key) для отправки

## Трекинг почтовых отправлений (РПО)

Реализует функции [API Почты России](https://tracking.pochta.ru/specification) для работы с отправлениями.  

Для работы используется экземпляр класса **TrackingClient**.  

**Входные параметры:**

- *\* - Логин

- *\* - Пароль

### Единичный доступ

Метод **GetHistoryAsync** используется для получения информации о конкретном отправлении.  

Возвращает **MailItem** содержащий информацию по всем операциям, совершенным над отправлением.  

**Пример:**

```C#

using PochtaAPI;

using PochtaAPI.Data;

TrackingClient TC = new TrackingClient(, );

MailItem MI = await TC.GetHistoryAsync();

```  

### Пакетный доступ (Не протестирован!)

Метод **GetTicketAsync** создает заявку в сервисе Почты России и возвращает **Ticket** содержащий код билета.  

Метод **GetBatchAsync** возвращает **Batch** содержащий информацию по отправлениям по ранее созданной заявке.

**Пример:**

```C#

using PochtaAPI;

using PochtaAPI.Data;

  

TrackingClient TC = new TrackingClient(, );

Ticket T = await TC.GetTicketAsync(new List() { ,  });

//Подождать мин. 15 минут

Batch B = await TC.GetBatchAsync(T.ID);

```

## Отправка почтовых отправлений (РПО)

Реализует функции [API Почты России](https://otpravka.pochta.ru/specification#/main) для работы с отправлениями.  

Для работы используется экземпляр класса **SendingClient**.  

**Входные параметры:**

- *\* - Токен

- *\* - Ключ

## PochtaForm

Используется для проверки работы библиотеки.