API docs by Redocly

CARD.COOP (1.0)

Download OpenAPI specification:Download

API для авторизации и управления пользователями

Auth

initiateRegistration

Инициализация регистрации

Request Body schema: application/json
email
required
string

Email пользователя

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com"
}

Response samples

Content type
application/json
{
  • "email": "user@example.com"
}

completeRegistration

Завершение регистрации

Request Body schema: application/json
email
required
string

Email пользователя

hash_key
required
string

Хэш-ключ для завершения регистрации

uuid
required
string

Уникальный идентификатор запроса

salt
required
string

Серверная соль для защиты данных

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "hash_key": "secureHash123",
  • "uuid": "uuid-123e4567-e89b-12d3-a456-426614174000",
  • "salt": "random-server-salt-example"
}

Response samples

Content type
application/json
{
  • "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

initiateLogin

Инициализация входа

Request Body schema: application/json
email
required
string

Email пользователя

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com"
}

Response samples

Content type
application/json
{
  • "email": "user@example.com"
}

completeLogin

Завершение входа

Request Body schema: application/json
email
required
string

Email пользователя

hash_key
required
string

Хэш-ключ для завершения входа

uuid
required
string

Уникальный идентификатор запроса

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "hash_key": "secureHash123",
  • "uuid": "uuid-123e4567-e89b-12d3-a456-426614174000"
}

Response samples

Content type
application/json
{
  • "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

refreshAccessToken

Обновление токена

Request Body schema: application/json
refresh_token
required
string

Refresh-токен для обновления токена доступа

Responses

Request samples

Content type
application/json
{
  • "refresh_token": "refreshtoken123"
}

Response samples

Content type
application/json
{
  • "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

logout

Выход

Request Body schema: application/json
access_token
required
string

Access-токен для удаления

refresh_token
required
string

Refresh-токен для удаления

Responses

Request samples

Content type
application/json
{
  • "access_token": "accesstoken123",
  • "refresh_token": "refreshtoken123"
}

Card

issueCard

Выпуск карты

Request Body schema: application/json
username
required
string

Имя пользователя, которому будет выдана карта

encrypted_key
required
string

Зашифрованный приватный ключ

encrypted_data
required
string

Зашифрованные данные, связанные с картой

required
object

Метаданные, связанные с картой

Responses

Request samples

Content type
application/json
{
  • "username": "user123",
  • "encrypted_key": "encryptedKey123456abcdef",
  • "encrypted_data": "encryptedData123456abcdef",
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174000",
  • "username": "username123"
}

getSchema

Извлечение актуальной схемы карты

Responses

Response samples

Content type
application/json
{
  • "oneOf": [
    ]
}

Access

prepareShareData

Подготовка данных для общего доступа

Request Body schema: application/json
coopname
required
string

Название кооператива

Responses

Request samples

Content type
application/json
{
  • "coopname": "CoopNameXYZ"
}

Response samples

Content type
application/json
{
  • "coopname": "voskhod",
  • "public_key": "EOS123456789abcdef",
  • "announce": "Потребительский Кооператив \"РОМАШКА\""
}

shareData

Передача данных

Request Body schema: application/json
username
required
string

Имя аккаунта пользователя

coopname
required
string

Имя аккаунта кооператива

encrypted_data
required
string

Зашифрованные данные для передачи

public_key
required
string

Публичный ключ кооператива необходимый для дешифровки

object

Не обязательные данные для идентификации устройства пользователя

Responses

Request samples

Content type
application/json
{
  • "username": "username",
  • "coopname": "voskhod",
  • "encrypted_data": "encryptedData123456abcdef",
  • "public_key": "EOSPublicKey123456abcdef",
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "ticket": "exchangeTicket12345"
}

exchangeTicketForJwt

Обмен тикета на JWT

Request Body schema: application/json
ticket
required
string

Билет для обмена кооперативной информацией

Responses

Request samples

Content type
application/json
{
  • "ticket": "exchangeTicket12345"
}

Response samples

Content type
application/json
{
  • "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

getEncryptedData

Получение зашифрованных данных

path Parameters
username
required
string
coopname
required
string

Responses

Response samples

Content type
application/json
{
  • "encrypted_data": "encrypted_string_example",
  • "coopname": "voskhod",
  • "username": "user123",
  • "public_key": "public_key_example",
  • "meta": { }
}