github.com/doslano-ru/doslano-go

Go SDK для Integration API Дослано — отправка заказных писем Почтой России из вашего кода


Keywords
api-client, doslano, go, pochta-rossii, registered-mail, sdk
Install
go get github.com/doslano-ru/doslano-go

Documentation

Go API client for doslano

Публичный REST API doslano: отправка заказных писем одним запросом, проверка статуса и трек-номеров (наш РПО + Почты России), баланс, колбеки на финальный статус письма.

Авторизация — API-ключ в заголовке Authorization: Bearer dl_live_…. Ключи и журнал активности — в ЛК, раздел «API». Ключ имеет набор прав (scopes) и (опционально) IP-allowlist.

Оплата — только с баланса аккаунта (предоплата). Пополнение — в ЛК.

Колбеки — необязательный callback_url указывается при отправке каждого письма; иначе используйте поллинг GET /v1/letters/{id}. Тело колбека подписывается HMAC-SHA256 секретом аккаунта (заголовок X-Doslano-Signature).

Это дополнительный интерфейс доступа к тем же услугам; использование регулируется действующей офертой личного кабинета doslano.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 1.0.0
  • Package version: 1.0.0
  • Generator version: 7.10.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://doslano.ru

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import doslano "github.com/doslano-ru/doslano-go"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value doslano.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), doslano.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value doslano.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), doslano.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using doslano.ContextOperationServerIndices and doslano.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), doslano.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), doslano.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://integration.doslano.ru

Class Method HTTP request Description
BalanceAPI GetBalance Get /v1/balance Баланс аккаунта
LettersAPI CreateLetter Post /v1/letters Отправить письмо
LettersAPI DownloadRecipientInventoryPdf Get /v1/letters/{id}/recipients/{recipient_id}/inventory.pdf PDF описи вложения получателя
LettersAPI DownloadRecipientReceiptPdf Get /v1/letters/{id}/recipients/{recipient_id}/receipt.pdf PDF фискального чека получателя
LettersAPI GetLetter Get /v1/letters/{id} Статус письма
LettersAPI GetRecipientTracking Get /v1/letters/{id}/recipients/{recipient_id}/tracking Трек-события получателя
LettersAPI ListLetters Get /v1/letters Список писем

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

apiKey

  • Type: HTTP Bearer token authentication

Example

auth := context.WithValue(context.Background(), doslano.ContextAccessToken, "BEARER_TOKEN_STRING")
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author