Документация · v1

Creodock API

Все операции
POSTПубличная операция

Создать: аккаунт и рабочую область

Создаёт аккаунт и рабочую область на основании переданного тела запроса.

OpenAPI: Create an account and send an email verification code

POSThttps://api.creodock.com/api/v1/auth/register
Кто вызывает
Публичная операция
Авторизация не требуется.
Доступ
Определяется ролью и принадлежностью объекта
Отдельный scope не объявлен в OpenAPI. Сервер проверяет роль и рабочую область.

Что произойдёт

Поведение, которое важно учесть до отправки запроса.

  • Создаёт ресурс или запускает команду, описанную в теле запроса.
  • Идемпотентность явно не объявлена в контракте: не повторяйте запрос автоматически.

Тело запроса

Обязательно для этой операции.

application/json

Схема: AccountRegistration

ПолеТипОписание
emailОбязательно
string · email
Email в нормализованном виде.Максимальная длина: 320
nameОбязательно
string
Отображаемое название.Минимальная длина: 2 · Максимальная длина: 80
passwordОбязательно
string
Поле «password» в структуре запроса или ответа.Минимальная длина: 15 · Максимальная длина: 72
referralCodeНеобязательно
string
Поле «referralCode» в структуре запроса или ответа.

Ответы

Все состояния ответа, объявленные этой операцией в OpenAPI.

202

Uniform response for new and existing email addresses; verification instructions are sent when applicable

application/json

Схема: AccountRegistrationResult

ПолеТипОписание
acceptedОбязательно
boolean
Поле «accepted» в структуре запроса или ответа.
emailОбязательно
string · email
Email в нормализованном виде.
verificationRequiredОбязательно
boolean
Поле «verificationRequired» в структуре запроса или ответа.
{
  "accepted": true,
  "email": "developer@example.com",
  "verificationRequired": true
}
422

Problem Details response

application/json

Схема: Problem

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

Не только причина, но и конкретное действие для вызывающей стороны.

СтатусЧто означаетПовторЧто делать
422Данные не прошли бизнес-проверкуПосле исправленияИсправьте поля, перечисленные в fieldErrors.

Формат Problem Details

{
  "type": "https://api.creodock.com/problems/invalid-request",
  "title": "Данные не прошли проверку",
  "status": 422,
  "code": "invalid_request",
  "detail": "Проверьте отмеченные поля.",
  "traceId": "req_01J8M4Y6QX",
  "fieldErrors": [
    { "field": "items[0].formats", "code": "required", "message": "Выберите формат." }
  ]
}