Package ru.moysklad.remap_1_2

Class ApiClient

java.lang.Object

ru.moysklad.remap_1_2.ApiClient

public final class ApiClient
extends Object

Constructor Summary

Constructors

Constructor	Description
ApiClient(String host, boolean forceHttps, String login, String password)	Создаёт экземпляр коннектора API
ApiClient(String host, boolean forceHttps, String login, String password, org.apache.http.impl.client.CloseableHttpClient client)	Создаёт экземпляр коннектора API

Method Summary

Modifier and Type	Method	Description
static com.google.gson.Gson	createGson()	Создаёт экземпляр GSON с настроенными сериализаторами и десериализаторами для некоторых классов и сущностей
static com.google.gson.Gson	createGson(boolean prettyPrinting)	Создаёт экземпляр GSON с настроенными сериализаторами и десериализаторами для некоторых классов и сущностей (с возможностью настроить форматированный вывод)
static ApiClient	createWithBearerToken(String host, boolean forceHttps, String token)
static ApiClient	createWithBearerToken(String host, boolean forceHttps, String token, org.apache.http.impl.client.CloseableHttpClient client)
EntityClient	entity()	Группа методов API, соответствующих пути /entity/* Внимание!
NotificationClient	notification()	Группа методов API, соответствующих пути /notification/* Внимание!
ApiClient	precision()
ApiClient	precision(boolean value)
ApiClient	prettyPrintJson()
ApiClient	prettyPrintJson(boolean value)
void	setCredentials(String login, String password)	Устанавливает данные доступа, которые используются для авторизации запросов к API
void	setHttpClient(org.apache.http.impl.client.CloseableHttpClient client)	Устанавливает пользовательский HTTP-клиент, с помощью которого будут выполняться запросы.
void	setToken(String token)	Устанавливает Bearer токен авторизации запрсоов к API
ApiClient	withoutWebhookContent()
ApiClient	withoutWebhookContent(boolean without)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApiClient

public ApiClient(String host,
                 boolean forceHttps,
                 String login,
                 String password)

Создаёт экземпляр коннектора API

Parameters:

host - хост, на котором располагается API

forceHttps - форсировать запрос через HTTPS

login - логин пользователя

password - пароль пользователя

ApiClient

public ApiClient(String host,
                 boolean forceHttps,
                 String login,
                 String password,
                 org.apache.http.impl.client.CloseableHttpClient client)

Создаёт экземпляр коннектора API

Parameters:

host - хост, на котором располагается API

forceHttps - форсировать запрос через HTTPS

login - логин пользователя

password - пароль пользователя

client - HTTP-клиент

Method Detail

createWithBearerToken

public static ApiClient createWithBearerToken(String host,
                                              boolean forceHttps,
                                              String token,
                                              org.apache.http.impl.client.CloseableHttpClient client)

createWithBearerToken

public static ApiClient createWithBearerToken(String host,
                                              boolean forceHttps,
                                              String token)

setCredentials

public void setCredentials(String login,
                           String password)

Устанавливает данные доступа, которые используются для авторизации запросов к API

Parameters:

login - логин в формате [имя_пользователя]@[название_компании]

password - пароль

setToken

public void setToken(String token)

Устанавливает Bearer токен авторизации запрсоов к API

Parameters:

token - Bearer токен авторизации

setHttpClient

public void setHttpClient(org.apache.http.impl.client.CloseableHttpClient client)

Устанавливает пользовательский HTTP-клиент, с помощью которого будут выполняться запросы.

entity

public EntityClient entity()

Группа методов API, соответствующих пути /entity/*

Внимание! Внутри этой цепочки методов каждый сегмент — это отдельный объект. По возможности избегайте их сохранения в переменные в долгоживущих объектах или не забывайте про них, так как неосторожное использование может вызвать утечку памяти!

notification

public NotificationClient notification()

Группа методов API, соответствующих пути /notification/*

Внимание! Внутри этой цепочки методов каждый сегмент — это отдельный объект. По возможности избегайте их сохранения в переменные в долгоживущих объектах или не забывайте про них, так как неосторожное использование может вызвать утечку памяти!

createGson

public static com.google.gson.Gson createGson()

Создаёт экземпляр GSON с настроенными сериализаторами и десериализаторами для некоторых классов и сущностей

createGson

public static com.google.gson.Gson createGson(boolean prettyPrinting)

Создаёт экземпляр GSON с настроенными сериализаторами и десериализаторами для некоторых классов и сущностей (с возможностью настроить форматированный вывод)

prettyPrintJson

public ApiClient prettyPrintJson()

prettyPrintJson

public ApiClient prettyPrintJson(boolean value)

precision

public ApiClient precision()

precision

public ApiClient precision(boolean value)

withoutWebhookContent

public ApiClient withoutWebhookContent()

withoutWebhookContent

public ApiClient withoutWebhookContent(boolean without)