i18n - docs translations (#19983)
Created by Github action Co-authored-by: github-actions <github-actions@twenty.com>
This commit is contained in:
github-actions[bot]
committed by
GitHub
GitHub
parent
f0a625c3f8
commit
f34ba6ac12
@@ -1,35 +1,35 @@
|
||||
---
|
||||
title: API
|
||||
icon: plug
|
||||
description: REST and GraphQL APIs generated from your workspace schema.
|
||||
description: REST и GraphQL API, сгенерированные на основе схемы вашего рабочего пространства.
|
||||
---
|
||||
|
||||
import { VimeoEmbed } from '/snippets/vimeo-embed.mdx';
|
||||
|
||||
## Schema-per-tenant APIs
|
||||
## API с отдельной схемой для каждого тенанта
|
||||
|
||||
There is no static API reference for Twenty. Each workspace has its own schema — when you add a custom object (say `Invoice`), it immediately gets REST and GraphQL endpoints identical to built-in objects like `Company` or `Person`. The API is generated from the schema, so endpoints use your object and field names directly — no opaque IDs.
|
||||
Для Twenty нет статической документации по API. У каждого рабочего пространства своя схема — когда вы добавляете пользовательский объект (например, `Invoice`), он сразу получает эндпоинты REST и GraphQL, идентичные встроенным объектам, таким как `Company` или `Person`. API генерируется из схемы, поэтому эндпоинты напрямую используют названия ваших объектов и полей — никаких непрозрачных идентификаторов.
|
||||
|
||||
Your workspace-specific API documentation is available under **Settings → API & Webhooks** after creating an API key. It includes an interactive playground where you can execute real calls against your data.
|
||||
Документация по API для вашего рабочего пространства доступна в разделе **Настройки → API и вебхуки** после создания ключа API. Она включает интерактивную песочницу, где вы можете выполнять реальные вызовы к своим данным.
|
||||
|
||||
## Two APIs
|
||||
## Два API
|
||||
|
||||
**Core API** — `/rest/` and `/graphql/`
|
||||
**Основное API** — `/rest/` и `/graphql/`
|
||||
|
||||
CRUD on records: People, Companies, Opportunities, your custom objects. Query, filter, traverse relations.
|
||||
CRUD над записями: Люди, Компании, Сделки, ваши пользовательские объекты. Запросы, фильтрация, переход по связям.
|
||||
|
||||
**Metadata API** — `/rest/metadata/` and `/metadata/`
|
||||
**API метаданных** — `/rest/metadata/` и `/metadata/`
|
||||
|
||||
Schema management: create/modify/delete objects, fields, and relations. This is how you programmatically change your data model.
|
||||
Управление схемой: создание/изменение/удаление объектов, полей и связей. Так вы программно изменяете свою модель данных.
|
||||
|
||||
Both are available as REST and GraphQL. GraphQL adds batch upserts and the ability to traverse relations in a single query. Same underlying data either way.
|
||||
Оба доступны как REST и GraphQL. GraphQL добавляет пакетные upsert-операции и возможность переходить по связям в одном запросе. В обоих случаях используются одни и те же базовые данные.
|
||||
|
||||
## Base URLs
|
||||
## Базовые URL-адреса
|
||||
|
||||
| Среда | Базовый URL |
|
||||
| ----------- | ------------------------- |
|
||||
| Cloud | `https://api.twenty.com/` |
|
||||
| Self-Hosted | `https://{your-domain}/` |
|
||||
| Среда | Базовый URL |
|
||||
| ----------------------- | ------------------------- |
|
||||
| Облако | `https://api.twenty.com/` |
|
||||
| Самостоятельный хостинг | `https://{your-domain}/` |
|
||||
|
||||
## Аутентификация
|
||||
|
||||
@@ -37,19 +37,19 @@ Both are available as REST and GraphQL. GraphQL adds batch upserts and the abili
|
||||
Authorization: Bearer YOUR_API_KEY
|
||||
```
|
||||
|
||||
Create an API key in **Settings → API & Webhooks → + Create key**. Copy it immediately — it's shown once. Keys can be scoped to a specific role under **Settings → Roles → Assignment tab** to limit what they can access.
|
||||
Создайте ключ API в **Settings → API & Webhooks → + Create key**. Сразу скопируйте его — он показывается только один раз. Ключам можно задать область действия для конкретной роли в разделе **Settings → Roles → Assignment tab**, чтобы ограничить их доступ.
|
||||
|
||||
<VimeoEmbed videoId="928786722" title="Создание ключа API" />
|
||||
|
||||
For OAuth-based access (external apps acting on behalf of users), see [OAuth](/l/ru/developers/extend/oauth).
|
||||
Для доступа на основе OAuth (внешние приложения, действующие от имени пользователей), см. [OAuth](/l/ru/developers/extend/oauth).
|
||||
|
||||
## Batch operations
|
||||
## Пакетные операции
|
||||
|
||||
Both REST and GraphQL support batching up to 60 records per request — create, update, or delete. GraphQL also supports batch upsert (create-or-update in one call) using plural names like `CreateCompanies`.
|
||||
И REST, и GraphQL поддерживают пакетную обработку до 60 записей за один запрос — создание, обновление или удаление. GraphQL также поддерживает пакетный upsert (создание или обновление за один вызов), используя имена во множественном числе, например `CreateCompanies`.
|
||||
|
||||
## Rate limits
|
||||
## Лимиты скорости
|
||||
|
||||
| Лимит | Значение |
|
||||
| ---------- | ------------------------- |
|
||||
| Requests | 100 per minute |
|
||||
| Batch size | 60 записей за один запрос |
|
||||
| Лимит | Значение |
|
||||
| ------------- | ------------------------- |
|
||||
| Запросы | 100 запросов в минуту |
|
||||
| Размер пакета | 60 записей за один запрос |
|
||||
|
||||
Reference in New Issue
Block a user