YandexTickets.ApiClients.Crm 1.0.3

There is a newer version of this package available.
See the version list below for details.
dotnet add package YandexTickets.ApiClients.Crm --version 1.0.3                
NuGet\Install-Package YandexTickets.ApiClients.Crm -Version 1.0.3                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="YandexTickets.ApiClients.Crm" Version="1.0.3" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add YandexTickets.ApiClients.Crm --version 1.0.3                
#r "nuget: YandexTickets.ApiClients.Crm, 1.0.3"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install YandexTickets.ApiClients.Crm as a Cake Addin
#addin nuget:?package=YandexTickets.ApiClients.Crm&version=1.0.3

// Install YandexTickets.ApiClients.Crm as a Cake Tool
#tool nuget:?package=YandexTickets.ApiClients.Crm&version=1.0.3                

CRM API Клиент

Возможности:

  • Получать списки городов, мероприятий, событий, покупателей, агентов и проданных билетов.
  • Получать информацию о заказах.
  • Строить отчеты о событиях.
  • Отписывать покупателей от рассылок.

Использование

Инициализация клиента

Для начала работы необходимо создать экземпляр YandexTicketsCrmApiClient, предоставив ему экземпляр HttpClient:

using YandexTickets.ApiClients.Crm;

var httpClient = new HttpClient();
var crmClient = new YandexTicketsCrmApiClient(httpClient);

Выполнение запросов

Получение списка городов
using YandexTickets.ApiClients.Common.Models.Enums;
using YandexTickets.ApiClients.Crm.Models.Requests;
using YandexTickets.ApiClients.Crm.Models.Responses;

// Создаем запрос
var request = new GetCityListRequest(authToken);

// Отправляем запрос
var response = await crmClient.GetCityListAsync(request);

if (response.Status == ResponseStatus.Success)
{
    var cities = response.Result;
    // Обрабатываем список городов
}
else
{
    Console.WriteLine($"Ошибка: {response.Error}");
}
Получение списка событий
int cityId = "идентификатор_города";
var request = new GetEventListRequest(authToken, cityId);
var response = await crmClient.GetEventListAsync(request);

if (response.Status == ResponseStatus.Success)
{
    var events = response.Result;
    // Обрабатываем список событий
}
else
{
    Console.WriteLine($"Ошибка: {response.Error}");
}

Методы клиента

Информационные запросы

  • GetCityListAsync - возвращает список городов.
  • GetActivityListAsync - возвращает список мероприятий.
  • GetEventListAsync - возвращает список событий.
  • GetOrderListAsync - возвращает список заказов.
  • GetOrderInfoAsync - возвращает детальную информацию о заказах.
  • GetCustomerListAsync - возвращает список покупателей.
  • GetAgentListAsync - возвращает список агентов.
  • GetEventReportAsync - возвращает отчеты о событиях.
  • GetSoldTicketsAsync - возвращает список проданных билетов. (Примечание: этот метод не описан в официальной документации API.)

Операции с покупателями

  • UnsubscribeCustomerAsync - отписывает покупателя от рассылок в системе Яндекс.Билеты.

Полезная информация

  • Классы запросов находятся в пространстве YandexTickets.ApiClients.Crm.Models.Requests.

  • Ответы от API представлены в виде классов из пространства YandexTickets.ApiClients.Crm.Models.Responses.

  • Используйте AuthService.GenerateAuthToken(string login, string password) для генерации токена авторизации, необходимого для выполнения запросов к API.

using YandexTickets.ApiClients.Common.Services;

string login = "login";
string password = "password";
string authToken = AuthService.GenerateAuthToken(login, password);
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.1.0 82 11/7/2024
1.0.3 76 10/29/2024

The first release of the Yandex.Tickets CRM API client.