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

Creodock API

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

Получить: реферальную программу

Возвращает реферальную программу. Запрос предназначен для чтения и не изменяет данные.

OpenAPI: Validate a public referral code without revealing its owner

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

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

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

  • Не изменяет данные и подходит для безопасного повторного чтения.
  • Повторный запрос возвращает актуальное состояние ресурса.

Параметры

Где передать значение, обязательно ли оно и откуда его получить.

ПолеГдеТипОписание
codeОбязательно
pathstring
Идентификатор ресурса в пути запроса: code.

Ответы

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

200

Valid referral code

404

Problem Details response

application/json

Схема: Problem

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

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

СтатусЧто означаетПовторЧто делать
404Объект не найден или скрыт правилами доступаНетПроверьте ID и принадлежность рабочей области.

Формат 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": "Выберите формат." }
  ]
}