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

Creodock API

API v1

Интеграция без догадок

От первого ключа до рабочего заказа: назначение операций, права, параметры, ответы, ошибки и безопасные повторы собраны в одном месте.

Всего операций
181
Для API-ключа
13

Путь первого запроса

Четыре шага, после которых интеграция готова к безопасной работе.

01

Создайте ключ

В разделе «Ключи» выберите только необходимые права. Секрет сохраните сразу — повторно он не показывается.

02

Проверьте контекст

Получите рабочую область и каталоги, чтобы использовать актуальные ID клиентов, услуг, форматов и исполнителей.

03

Выполните сценарий

Создайте клиента или заказ, передав Idempotency-Key для поддерживающих его команд.

04

Подключите события

Настройте webhook, проверьте подпись и используйте журнал API для поиска запросов по traceId.

Правила платформы

Общее поведение API, которое не нужно заново угадывать у каждой ручки.

Авторизация

Как создать ключ, ограничить права и безопасно передать его серверному приложению.

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

Ошибки

Единый Problem Details: стабильный code, понятный detail, ошибки полей и traceId.

HTTP-статус определяет класс ошибки, code подходит для программной обработки, traceId связывает запрос с журналом.

Повтор запросов

Когда запрос можно повторить и как Idempotency-Key защищает от дублей.

Автоматически повторяйте только безопасные чтения и команды, где Idempotency-Key явно присутствует в контракте.

Пагинация

Списки используют непрозрачный cursor и ограничение размера страницы.

Не разбирайте значение курсора. Передавайте nextCursor без изменений; его отсутствие означает конец списка.

Версии

Версия v1 фиксирует публичный контракт и отделяет его от внутренних изменений продукта.

Добавления остаются совместимыми. Удаления и переименования требуют новой версии и периода миграции.

Webhooks

Подпись, повторная доставка, защита от дублей и связь события с исходной операцией.

Сначала проверяйте подпись и сохраняйте ID доставки, затем быстро отвечайте 2xx и обрабатывайте событие асинхронно.

Справочник операций

Поиск работает по назначению, пути, operationId и предметной области.

Заказы и креативы

19 операций
GET
Получить заказы участникаlistTeamMemberTasks
/organizations/{organizationId}/team/members/{memberId}/tasksGET
Получить список: доску заказовlistKanbanBoard
/organizations/{organizationId}/boardGET
Получить список: доску заказовlistKanbanColumn
/organizations/{organizationId}/board/columns/{stage}GET
Получить список: креативыlistMyWorkPositions
/organizations/{organizationId}/positionsPOST
Выполнить действие: креативыperformPositionAction
/organizations/{organizationId}/positions/{positionId}/actionsGET
Получить: креативыgetPositionResultContent
/organizations/{organizationId}/positions/{positionId}/results/{assetId}/contentPOST
Создать: загрузку результатаreservePositionResultUpload
/organizations/{organizationId}/positions/{positionId}/results/uploadsDELETE
Отменить: загрузку результатаcancelPositionResultUpload
/organizations/{organizationId}/positions/{positionId}/results/uploads/{reservationId}POST
Создать: загрузку результатаcompletePositionResultUpload
/organizations/{organizationId}/positions/{positionId}/results/uploads/{reservationId}/completeGET
Получить список: заказыlistQueueTasks
/organizations/{organizationId}/tasksPOST
Создать заказcreateTask
/organizations/{organizationId}/tasksGET
Получить: заказыgetTask
/organizations/{organizationId}/tasks/{taskId}PUT
Изменить: заказыupdateTask
/organizations/{organizationId}/tasks/{taskId}POST
Выполнить действие: заказыperformTaskAction
/organizations/{organizationId}/tasks/{taskId}/actionsPOST
Создать: загрузку референсаreserveTaskReferenceUpload
/organizations/{organizationId}/tasks/{taskId}/references/uploadsDELETE
Отменить: загрузку референсаcancelTaskReferenceUpload
/organizations/{organizationId}/tasks/{taskId}/references/uploads/{reservationId}POST
Создать: загрузку референсаcompleteTaskReferenceUpload
/organizations/{organizationId}/tasks/{taskId}/references/uploads/{reservationId}/completeGET
Получить: заказыgetTaskByNumber
/organizations/{organizationId}/tasks/by-number/{orderNumber}GET
Получить: заказыgetTaskNumberPreview
/organizations/{organizationId}/tasks/number-preview

Клиенты

17 операций
DELETE
Удалить внутреннюю заметку клиентаdeleteClientNote
/organizations/{organizationId}/clients/{clientId}/notes/{noteId}PATCH
Изменить внутреннюю заметку клиентаupdateClientNote
/organizations/{organizationId}/clients/{clientId}/notes/{noteId}GET
Получить список: клиентовlistClients
/organizations/{organizationId}/clientsPOST
Создать: клиентовcreateClient
/organizations/{organizationId}/clientsGET
Получить: клиентовgetClient
/organizations/{organizationId}/clients/{clientId}PATCH
Изменить: клиентовupdateClient
/organizations/{organizationId}/clients/{clientId}POST
Выполнить действие: клиентовperformClientAction
/organizations/{organizationId}/clients/{clientId}/actionsGET
Получить: клиентовgetClientActivity
/organizations/{organizationId}/clients/{clientId}/activityGET
Получить список: клиентовlistClientContacts
/organizations/{organizationId}/clients/{clientId}/contactsPOST
Создать: клиентовupsertClientContact
/organizations/{organizationId}/clients/{clientId}/contactsGET
Получить: клиентовgetClientFinance
/organizations/{organizationId}/clients/{clientId}/financePOST
Создать: клиентовperformClientFinancialAction
/organizations/{organizationId}/clients/{clientId}/financial-actionsPOST
Создать: клиентовcreateClientNote
/organizations/{organizationId}/clients/{clientId}/notesGET
Получить: клиентовgetClientOverview
/organizations/{organizationId}/clients/{clientId}/overviewPOST
Создать: клиентовcreateWorkspaceClientPayment
/organizations/{organizationId}/clients/{clientId}/paymentsGET
Получить: клиентовgetClientPrices
/organizations/{organizationId}/clients/{clientId}/pricesPATCH
Изменить: клиентовupdateClientPrice
/organizations/{organizationId}/clients/{clientId}/prices

Команда

17 операций
GET
Получить права участникаgetTeamMemberAccess
/organizations/{organizationId}/team/members/{memberId}/accessPATCH
Изменить права участникаupdateTeamMemberAccess
/organizations/{organizationId}/team/members/{memberId}/accessGET
Получить начисления участникаlistTeamMemberAccruals
/organizations/{organizationId}/team/members/{memberId}/accrualsGET
Получить оперативную сводку участникаgetTeamMemberOverview
/organizations/{organizationId}/team/members/{memberId}/overviewGET
Получить результаты участникаlistTeamMemberResults
/organizations/{organizationId}/team/members/{memberId}/resultsPOST
Создать: командаinviteTeamMember
/organizations/{organizationId}/team/invitationsPOST
Создать: командаresendTeamInvitation
/organizations/{organizationId}/team/invitations/{invitationId}/resendPOST
Создать: командаrevokeTeamInvitation
/organizations/{organizationId}/team/invitations/{invitationId}/revokeGET
Получить список: участников командыlistTeamMembers
/organizations/{organizationId}/team/membersGET
Получить: участников командыgetTeamMember
/organizations/{organizationId}/team/members/{memberId}PATCH
Изменить: участников командыupdateWorkspaceTeamMember
/organizations/{organizationId}/team/members/{memberId}POST
Выполнить действие: участников командыperformTeamMemberAction
/organizations/{organizationId}/team/members/{memberId}/actionsGET
Получить список: участников командыlistTeamMemberCreatives
/organizations/{organizationId}/team/members/{memberId}/creativesGET
Получить список: командаlistTeamResults
/organizations/{organizationId}/team/resultsGET
Получить: командаgetTeamSummary
/organizations/{organizationId}/team/summaryGET
Получить список: лимиты загрузки командыlistTeamWorkload
/organizations/{organizationId}/team/workloadPATCH
Изменить: лимиты загрузки командыupdateTeamWorkloadLimits
/organizations/{organizationId}/team/workload-limits

Рабочая область

35 операций
GET
Получить: рабочая областьgetWorkspaceAvatar
/organizations/{organizationId}/avatarPOST
Передать владение или архивировать рабочую областьperformWorkspaceAction
/organizations/{organizationId}/actionsGET
Получить список: рабочая областьlistWorkspaceAuditEvents
/organizations/{organizationId}/audit-eventsPOST
Создать: рабочая областьupdateWorkspaceAvatar
/organizations/{organizationId}/avatarGET
Получить: каталог рабочей областиgetTaskCatalog
/organizations/{organizationId}/catalogPOST
Создать одноразовое или переиспользуемое значение из заказаcreateWorkspaceCatalogDraft
/organizations/{organizationId}/catalog-draftsGET
Получить переиспользуемые записи справочникаlistWorkspaceCatalogItems
/organizations/{organizationId}/catalogs/{kind}POST
Создать переиспользуемую запись справочникаcreateWorkspaceCatalogItem
/organizations/{organizationId}/catalogs/{kind}PATCH
Переименовать, архивировать или восстановить запись справочникаupdateWorkspaceCatalogItem
/organizations/{organizationId}/catalogs/{kind}/{itemId}GET
Получить: рабочая областьgetWorkspaceContext
/organizations/{organizationId}/contextGET
Получить список: рабочая областьlistCreatives
/organizations/{organizationId}/creativesGET
Получить: рабочая областьgetCreative
/organizations/{organizationId}/creatives/{creativeId}POST
Выполнить действие: рабочая областьactOnCreative
/organizations/{organizationId}/creatives/{creativeId}/actionsGET
Получить список: рабочая областьlistCreativeReviewQueue
/organizations/{organizationId}/creatives/reviewGET
Получить список: рабочая областьlistIntegrations
/organizations/{organizationId}/integrationsPOST
Создать: рабочая областьcreateIntegrationConnection
/organizations/{organizationId}/integrationsGET
Получить: рабочая областьgetIntegrationConnection
/organizations/{organizationId}/integrations/{connectionId}POST
Выполнить действие: рабочая областьactOnIntegrationConnection
/organizations/{organizationId}/integrations/{connectionId}/actionsGET
Получить список: рабочая областьlistMyPayouts
/organizations/{organizationId}/me/payoutsGET
Получить список: рабочая областьlistMyCreativePayoutRates
/organizations/{organizationId}/me/ratesGET
Получить: рабочая областьgetOperationalOverview
/organizations/{organizationId}/overviewGET
Получить системные и пользовательские ролиlistWorkspaceRoles
/organizations/{organizationId}/rolesPOST
Создать пользовательскую рольcreateWorkspaceRole
/organizations/{organizationId}/rolesPATCH
Изменить название, описание и права пользовательской ролиupdateWorkspaceRole
/organizations/{organizationId}/roles/{roleId}POST
Архивировать или восстановить пользовательскую рольperformWorkspaceRoleAction
/organizations/{organizationId}/roles/{roleId}/actionsGET
Получить основные настройки рабочей областиgetWorkspaceSettings
/organizations/{organizationId}/settingsPATCH
Изменить основные настройки и параметры заказовupdateWorkspaceSettings
/organizations/{organizationId}/settingsGET
Получить видимость вкладок по ролямgetWorkspaceRoleNavigation
/organizations/{organizationId}/settings/navigationPATCH
Изменить видимость вкладок для ролиupdateWorkspaceRoleNavigation
/organizations/{organizationId}/settings/navigationGET
Получить список: рабочая областьlistVerticals
/organizations/{organizationId}/verticalsPOST
Создать: рабочая областьcreateVertical
/organizations/{organizationId}/verticalsPATCH
Изменить: рабочая областьupdateVertical
/organizations/{organizationId}/verticals/{verticalId}GET
GET: рабочая областьvalidateTeamInvitation
/invitations/{token}POST
Создать: рабочая областьacceptTeamInvitation
/invitations/{token}/acceptGET
Получить: реферальную программуgetPublicReferral
/referrals/{code}

Финансы

32 операций
POST
Создать компенсирующую финансовую проводкуcreateFinanceAdjustment
/organizations/{organizationId}/finance/adjustmentsGET
Получить ставки начислений командыlistCreativePayoutRates
/organizations/{organizationId}/finance/ratesPATCH
Изменить ставку начисленияupdateCreativePayoutRate
/organizations/{organizationId}/finance/ratesPOST
Получить: ставки исполнителейresolveCreativePayoutRate
/organizations/{organizationId}/finance/rates/resolveGET
Получить: баланс аккаунтаgetPersonalBalance
/me/balancePOST
Создать: баланс аккаунтаcreatePersonalBalanceDeposit
/me/balance/depositsGET
Получить: баланс аккаунтаgetPersonalBalanceDeposit
/me/balance/deposits/{depositId}GET
Получить: баланс аккаунтаgetActivePersonalBalanceDeposit
/me/balance/deposits/activeGET
Получить список: баланс аккаунтаlistPersonalBalanceOperations
/me/balance/operationsGET
Получить: подписку аккаунтаgetPersonalSubscription
/me/subscriptionPOST
Выполнить действие: подписку аккаунтаactOnPersonalSubscription
/me/subscription/actionsGET
Получить список: подписку аккаунтаlistPersonalSubscriptionPlans
/me/subscription/plansGET
Получить: финансыgetFinanceAccess
/organizations/{organizationId}/finance/accessPATCH
Изменить: финансыupdateFinanceAccess
/organizations/{organizationId}/finance/accessGET
Получить список: балансы клиентовlistFinanceClientBalances
/organizations/{organizationId}/finance/client-balancesPOST
Создать: финансыexportFinance
/organizations/{organizationId}/finance/exportsGET
Получить список: счетаlistFinanceInvoices
/organizations/{organizationId}/finance/invoicesPOST
Создать: счетаcreateFinanceInvoice
/organizations/{organizationId}/finance/invoicesGET
Получить: счетаgetFinanceInvoice
/organizations/{organizationId}/finance/invoices/{invoiceId}POST
Выполнить действие: счетаperformFinanceInvoiceAction
/organizations/{organizationId}/finance/invoices/{invoiceId}/actionsGET
Получить список: финансовые операцииlistFinancialOperations
/organizations/{organizationId}/finance/operationsGET
Получить: финансовые операцииgetFinancialOperation
/organizations/{organizationId}/finance/operations/{operationId}POST
Выполнить действие: финансовые операцииreverseFinancialOperation
/organizations/{organizationId}/finance/operations/{operationId}/actionsGET
Получить: финансыgetFinanceOverview
/organizations/{organizationId}/finance/overviewGET
Получить список: платежи клиентовlistClientPayments
/organizations/{organizationId}/finance/paymentsPOST
Создать: платежи клиентовcreateClientPayment
/organizations/{organizationId}/finance/paymentsPOST
Выполнить действие: платежи клиентовperformClientPaymentAction
/organizations/{organizationId}/finance/payments/{paymentId}/actionsGET
Получить список: выплатыlistPayoutPeriods
/organizations/{organizationId}/finance/payout-periodsPOST
Создать: выплатыcreatePayoutPeriod
/organizations/{organizationId}/finance/payout-periodsGET
Получить список: выплатыlistFinancePayouts
/organizations/{organizationId}/finance/payoutsPOST
Создать: выплатыcreatePayoutStatement
/organizations/{organizationId}/finance/payoutsPOST
Выполнить действие: выплатыperformPayoutAction
/organizations/{organizationId}/finance/payouts/{payoutId}/actions

Аккаунт

26 операций
POST
Создать: аккаунтupdateAccountPresence
/auth/presenceDELETE
Завершить текущую сессиюrevokeLoginSession
/auth/sessionGET
Определить стартовую рабочую область действующей сессииresolveLoginSession
/auth/sessionGET
Получить: аккаунтgetPersonalAvatar
/me/avatarPOST
Создать: аккаунтupdatePersonalAvatar
/me/avatarGET
Получить список: аккаунтlistIncomingAccountInvitations
/me/invitationsPOST
Создать: аккаунтacceptIncomingAccountInvitation
/me/invitations/{invitationId}/acceptPOST
Создать: аккаунтdeclineIncomingAccountInvitation
/me/invitations/{invitationId}/declineGET
Получить: аккаунтgetMFAStatus
/me/mfaPOST
Создать: аккаунтconfirmTOTP
/me/mfa/totp/confirmPOST
Создать: аккаунтdisableTOTP
/me/mfa/totp/disablePOST
Создать: аккаунтenrollTOTP
/me/mfa/totp/enrollPOST
Создать: аккаунтcreatePersonalWorkspace
/me/organizationsGET
Получить: аккаунтgetPersonalProfile
/me/profilePATCH
Изменить: аккаунтupdatePersonalProfile
/me/profileGET
Получить: реферальную программуgetPersonalReferralDashboard
/me/referralsGET
Получить список: аккаунтlistAccountSessions
/me/sessionsDELETE
DELETE: аккаунтrevokeAccountSession
/me/sessions/{sessionId}POST
Создать: аккаунтrevokeOtherAccountSessions
/me/sessions/revoke-othersPOST
Войти в Creodock по email и паролюloginAccount
/auth/loginPOST
Создать: сессию пользователяcompleteMFALogin
/auth/login/mfaPOST
Создать: аккаунтrequestPasswordRecovery
/auth/password/forgotPOST
Создать: аккаунтresetAccountPassword
/auth/password/resetPOST
Создать: аккаунт и рабочую областьregisterAccount
/auth/registerPOST
Создать: аккаунтverifyAccountEmail
/auth/verify-emailPOST
Создать: аккаунтresendAccountEmailVerification
/auth/verify-email/resend

Материалы

6 операций
GET
Получить список: материалыlistMaterials
/organizations/{organizationId}/materialsPOST
Выполнить действие: материалыperformMaterialAction
/organizations/{organizationId}/materials/actionsGET
Получить: содержимое файлаgetMaterialContent
/organizations/{organizationId}/materials/files/{fileId}/contentPOST
Создать: загрузку материалаreserveMaterialUpload
/organizations/{organizationId}/materials/uploadsDELETE
Отменить: загрузку материалаcancelMaterialUpload
/organizations/{organizationId}/materials/uploads/{reservationId}POST
Создать: загрузку материалаcompleteMaterialUpload
/organizations/{organizationId}/materials/uploads/{reservationId}/complete

Трекеры

8 операций
GET
Получить список: публичные трекерыlistTrackers
/organizations/{organizationId}/trackersPOST
Создать: публичные трекерыcreateTracker
/organizations/{organizationId}/trackersDELETE
Удалить: публичные трекерыdeleteTracker
/organizations/{organizationId}/trackers/{trackerId}GET
Получить: публичные трекерыgetTracker
/organizations/{organizationId}/trackers/{trackerId}PATCH
Изменить: публичные трекерыpatchTracker
/organizations/{organizationId}/trackers/{trackerId}GET
Получить: публичные трекерыgetTrackerCatalog
/organizations/{organizationId}/trackers/catalogGET
Получить: публичные трекерыgetPublicTracker
/public/trackers/{token}POST
Создать: публичные трекерыrecordPublicTrackerView
/public/trackers/{token}/views

Уведомления

3 операций
GET
Получить список: уведомленияlistWorkspaceNotifications
/organizations/{organizationId}/notificationsPATCH
Отметить: уведомленияmarkWorkspaceNotificationRead
/organizations/{organizationId}/notifications/{notificationId}POST
Создать: уведомленияmarkAllWorkspaceNotificationsRead
/organizations/{organizationId}/notifications/read-all

Developer API

10 операций
GET
Получить журнал API и webhook deliverieslistWorkspaceAPIActivity
/organizations/{organizationId}/integrations/api/activityGET
Получить доставки webhookslistWorkspaceWebhookDeliveries
/organizations/{organizationId}/integrations/api/deliveriesGET
Получить API-ключи рабочей областиlistWorkspaceAPIKeys
/organizations/{organizationId}/integrations/api/keysPOST
Создать API-ключcreateWorkspaceAPIKey
/organizations/{organizationId}/integrations/api/keysPATCH
Переименовать API-ключrenameWorkspaceAPIKey
/organizations/{organizationId}/integrations/api/keys/{keyId}POST
Ротировать или отозвать API-ключactOnWorkspaceAPIKey
/organizations/{organizationId}/integrations/api/keys/{keyId}/actionsGET
Получить webhookslistWorkspaceWebhooks
/organizations/{organizationId}/integrations/api/webhooksPOST
Добавить webhookcreateWorkspaceWebhook
/organizations/{organizationId}/integrations/api/webhooksGET
Получить webhookgetWorkspaceWebhook
/organizations/{organizationId}/integrations/api/webhooks/{webhookId}POST
Управлять webhookactOnWorkspaceWebhook
/organizations/{organizationId}/integrations/api/webhooks/{webhookId}/actions

Telegram Bot

6 операций
DELETE
Отключить Telegram от личного аккаунтаdisconnectPersonalTelegram
/me/telegramGET
Получить личное подключение TelegramgetPersonalTelegramConnection
/me/telegramPOST
Создать одноразовую ссылку подключенияcreateTelegramLinkIntent
/me/telegram/link-intentsGET
Получить настройки Telegram для рабочей областиgetWorkspaceTelegramPreferences
/organizations/{organizationId}/me/telegram/preferencesPATCH
Изменить настройки Telegram для рабочей областиupdateWorkspaceTelegramPreferences
/organizations/{organizationId}/me/telegram/preferencesPOST
Отправить тестовое уведомлениеsendWorkspaceTelegramTest
/organizations/{organizationId}/me/telegram/test

Система

2 операций
GET
GET: состояние процессаhealth
/healthzGET
GET: готовность зависимостейreadiness
/readyz