# Ozon ОРД API - Python
Клиент для взаимодействия с системой управления рекламными данными Ozon ОРД через API.
**Что представляет собой Ozon ОРД API**
Ozon ОРД API — это программный интерфейс, предназначенный для передачи данных между системой поставщика данных и Ozon.
Используя функции Ozon ОРД API, можно осуществлять регистрацию, обновление и получение информации о договорах, креативах, документах, контрагентах и рекламных площадках.
## Установка
### C помощью pip
1. Установите pip
2. Выполните команду
```
pip install ozon-ord
```
## Начало работы
1. Установите данные для конфигурации
**Для тестового окружения (если используете [Ozon ОРД Sandbox](https://ord-sandbox.ozon.ru)):**
```
from ozon_ord import Config, OzonORDClient
_environment="TEST"
OzonORDClient.set_environment(environment=_environment)
Config.set_api_key(key="api_key", environment=_environment)
```
Замените api_key на значение полученное в профиле пользователя [Ozon ОРД Sandbox](https://ord-sandbox.ozon.ru/profile/api).
**Для продового окружения:**
```
from ozon_ord import Config, OzonORDClient
Config.set_api_key(key="api_key")
```
Достаточно указать только значение api_key. Скопируйте из профиля пользователя [Ozon ОРД](https://ord.ozon.ru/profile/api).
2. Вызовите необходимый метод API. [Документация Ozon ОРД](https://docs.ozon.ru/api/ord/).
## Примеры
### Работа с платформами
```
from ozon_ord import Config, OzonORDClient
from ozon_ord.platform import Platform
from ozon_ord.models import (
PlatformData,
BatchPlatformRequest,
PlatformRequest,
PlatformListRequest,
PlatformCursor,
UpdatedAt,
)
_environment="TEST"
OzonORDClient.set_environment(environment=_environment)
Config.set_api_key(key="api_key", environment=_environment)
# Регистрация или обновление данных площадки
platform_data = PlatformData(
appName="Название площадки",
externalPlatformId="example_id_88",
platformType="PLATFORM_TYPE_SITE",
url="http://example.com/",
comment="Комментарий или описание",
)
response = Platform.register_or_update_platform(platform_data)
print(response)
# Регистрация или обновление данных для нескольких площадок
platforms_data = BatchPlatformRequest(
platforms=[
PlatformRequest(
appName="Название площадки 1",
externalPlatformId="example_id_12",
platformType="PLATFORM_TYPE_SITE",
url="http://example.com/app_one",
comment="Example comment for app one",
),
PlatformRequest(
appName="Название площадки 2",
externalPlatformId="example_id_13",
platformType="PLATFORM_TYPE_SITE",
url="http://example.com/app_two",
comment="Комментарий или описание 1",
),
PlatformRequest(
appName="Example App 34",
externalPlatformId="example_id_34",
platformType="PLATFORM_TYPE_SITE",
url="http://example.com/app_one",
comment="Комментарий или описание 2",
),
]
)
response = Platform.register_or_update_multiple_platforms(platforms_data)
print(response)
# Информация о площадке
externalPlatformId = "example_id_12"
response = Platform.get_platform_info(externalPlatformId)
print(response)
# Список площадок
request_data = PlatformListRequest(
cursor=PlatformCursor(
externalId="",
updatedAt={},
),
orderBy="ASC",
pageSize=0,
)
response = Platform.get_platform_list(request_data)
print(response)
```
### Другие примеры
Другие примеры вы найдете в папке **"examples"**.
Raw data
{
"_id": null,
"home_page": "https://github.com/frollow/ozon-ord",
"name": "ozon-ord",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "ozon, ord, ozon-ord, api, sdk, python",
"author": "Artem Frolov",
"author_email": "pypi-username@mail.ru",
"download_url": "https://files.pythonhosted.org/packages/ed/ed/9e9b6d1739e9213dd05c150b218dfd977106f68da8af4e94e086f6120b4e/ozon_ord-0.0.1b1.tar.gz",
"platform": null,
"description": "# Ozon \u041e\u0420\u0414 API - Python\n\n\u041a\u043b\u0438\u0435\u043d\u0442 \u0434\u043b\u044f \u0432\u0437\u0430\u0438\u043c\u043e\u0434\u0435\u0439\u0441\u0442\u0432\u0438\u044f \u0441 \u0441\u0438\u0441\u0442\u0435\u043c\u043e\u0439 \u0443\u043f\u0440\u0430\u0432\u043b\u0435\u043d\u0438\u044f \u0440\u0435\u043a\u043b\u0430\u043c\u043d\u044b\u043c\u0438 \u0434\u0430\u043d\u043d\u044b\u043c\u0438 Ozon \u041e\u0420\u0414 \u0447\u0435\u0440\u0435\u0437 API.\n\n**\u0427\u0442\u043e \u043f\u0440\u0435\u0434\u0441\u0442\u0430\u0432\u043b\u044f\u0435\u0442 \u0441\u043e\u0431\u043e\u0439 Ozon \u041e\u0420\u0414 API**\nOzon \u041e\u0420\u0414 API \u2014 \u044d\u0442\u043e \u043f\u0440\u043e\u0433\u0440\u0430\u043c\u043c\u043d\u044b\u0439 \u0438\u043d\u0442\u0435\u0440\u0444\u0435\u0439\u0441, \u043f\u0440\u0435\u0434\u043d\u0430\u0437\u043d\u0430\u0447\u0435\u043d\u043d\u044b\u0439 \u0434\u043b\u044f \u043f\u0435\u0440\u0435\u0434\u0430\u0447\u0438 \u0434\u0430\u043d\u043d\u044b\u0445 \u043c\u0435\u0436\u0434\u0443 \u0441\u0438\u0441\u0442\u0435\u043c\u043e\u0439 \u043f\u043e\u0441\u0442\u0430\u0432\u0449\u0438\u043a\u0430 \u0434\u0430\u043d\u043d\u044b\u0445 \u0438 Ozon.\n\n\u0418\u0441\u043f\u043e\u043b\u044c\u0437\u0443\u044f \u0444\u0443\u043d\u043a\u0446\u0438\u0438 Ozon \u041e\u0420\u0414 API, \u043c\u043e\u0436\u043d\u043e \u043e\u0441\u0443\u0449\u0435\u0441\u0442\u0432\u043b\u044f\u0442\u044c \u0440\u0435\u0433\u0438\u0441\u0442\u0440\u0430\u0446\u0438\u044e, \u043e\u0431\u043d\u043e\u0432\u043b\u0435\u043d\u0438\u0435 \u0438 \u043f\u043e\u043b\u0443\u0447\u0435\u043d\u0438\u0435 \u0438\u043d\u0444\u043e\u0440\u043c\u0430\u0446\u0438\u0438 \u043e \u0434\u043e\u0433\u043e\u0432\u043e\u0440\u0430\u0445, \u043a\u0440\u0435\u0430\u0442\u0438\u0432\u0430\u0445, \u0434\u043e\u043a\u0443\u043c\u0435\u043d\u0442\u0430\u0445, \u043a\u043e\u043d\u0442\u0440\u0430\u0433\u0435\u043d\u0442\u0430\u0445 \u0438 \u0440\u0435\u043a\u043b\u0430\u043c\u043d\u044b\u0445 \u043f\u043b\u043e\u0449\u0430\u0434\u043a\u0430\u0445.\n\n## \u0423\u0441\u0442\u0430\u043d\u043e\u0432\u043a\u0430\n\n### C \u043f\u043e\u043c\u043e\u0449\u044c\u044e pip\n\n1. \u0423\u0441\u0442\u0430\u043d\u043e\u0432\u0438\u0442\u0435 pip\n2. \u0412\u044b\u043f\u043e\u043b\u043d\u0438\u0442\u0435 \u043a\u043e\u043c\u0430\u043d\u0434\u0443\n\n```\npip install ozon-ord\n```\n\n## \u041d\u0430\u0447\u0430\u043b\u043e \u0440\u0430\u0431\u043e\u0442\u044b\n\n1. \u0423\u0441\u0442\u0430\u043d\u043e\u0432\u0438\u0442\u0435 \u0434\u0430\u043d\u043d\u044b\u0435 \u0434\u043b\u044f \u043a\u043e\u043d\u0444\u0438\u0433\u0443\u0440\u0430\u0446\u0438\u0438\n\n**\u0414\u043b\u044f \u0442\u0435\u0441\u0442\u043e\u0432\u043e\u0433\u043e \u043e\u043a\u0440\u0443\u0436\u0435\u043d\u0438\u044f (\u0435\u0441\u043b\u0438 \u0438\u0441\u043f\u043e\u043b\u044c\u0437\u0443\u0435\u0442\u0435 [Ozon \u041e\u0420\u0414 Sandbox](https://ord-sandbox.ozon.ru)):**\n\n```\nfrom ozon_ord import Config, OzonORDClient\n\n_environment=\"TEST\"\nOzonORDClient.set_environment(environment=_environment)\nConfig.set_api_key(key=\"api_key\", environment=_environment)\n```\n\n\u0417\u0430\u043c\u0435\u043d\u0438\u0442\u0435 api_key \u043d\u0430 \u0437\u043d\u0430\u0447\u0435\u043d\u0438\u0435 \u043f\u043e\u043b\u0443\u0447\u0435\u043d\u043d\u043e\u0435 \u0432 \u043f\u0440\u043e\u0444\u0438\u043b\u0435 \u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u0435\u043b\u044f [Ozon \u041e\u0420\u0414 Sandbox](https://ord-sandbox.ozon.ru/profile/api).\n\n**\u0414\u043b\u044f \u043f\u0440\u043e\u0434\u043e\u0432\u043e\u0433\u043e \u043e\u043a\u0440\u0443\u0436\u0435\u043d\u0438\u044f:**\n\n```\nfrom ozon_ord import Config, OzonORDClient\n\nConfig.set_api_key(key=\"api_key\")\n```\n\n\u0414\u043e\u0441\u0442\u0430\u0442\u043e\u0447\u043d\u043e \u0443\u043a\u0430\u0437\u0430\u0442\u044c \u0442\u043e\u043b\u044c\u043a\u043e \u0437\u043d\u0430\u0447\u0435\u043d\u0438\u0435 api_key. \u0421\u043a\u043e\u043f\u0438\u0440\u0443\u0439\u0442\u0435 \u0438\u0437 \u043f\u0440\u043e\u0444\u0438\u043b\u044f \u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u0435\u043b\u044f [Ozon \u041e\u0420\u0414](https://ord.ozon.ru/profile/api).\n\n2. \u0412\u044b\u0437\u043e\u0432\u0438\u0442\u0435 \u043d\u0435\u043e\u0431\u0445\u043e\u0434\u0438\u043c\u044b\u0439 \u043c\u0435\u0442\u043e\u0434 API. [\u0414\u043e\u043a\u0443\u043c\u0435\u043d\u0442\u0430\u0446\u0438\u044f Ozon \u041e\u0420\u0414](https://docs.ozon.ru/api/ord/).\n\n## \u041f\u0440\u0438\u043c\u0435\u0440\u044b\n\n### \u0420\u0430\u0431\u043e\u0442\u0430 \u0441 \u043f\u043b\u0430\u0442\u0444\u043e\u0440\u043c\u0430\u043c\u0438\n\n```\nfrom ozon_ord import Config, OzonORDClient\n\nfrom ozon_ord.platform import Platform\nfrom ozon_ord.models import (\n PlatformData,\n BatchPlatformRequest,\n PlatformRequest,\n PlatformListRequest,\n PlatformCursor,\n UpdatedAt,\n)\n\n\n_environment=\"TEST\"\nOzonORDClient.set_environment(environment=_environment)\nConfig.set_api_key(key=\"api_key\", environment=_environment)\n\n\n# \u0420\u0435\u0433\u0438\u0441\u0442\u0440\u0430\u0446\u0438\u044f \u0438\u043b\u0438 \u043e\u0431\u043d\u043e\u0432\u043b\u0435\u043d\u0438\u0435 \u0434\u0430\u043d\u043d\u044b\u0445 \u043f\u043b\u043e\u0449\u0430\u0434\u043a\u0438\nplatform_data = PlatformData(\n appName=\"\u041d\u0430\u0437\u0432\u0430\u043d\u0438\u0435 \u043f\u043b\u043e\u0449\u0430\u0434\u043a\u0438\",\n externalPlatformId=\"example_id_88\",\n platformType=\"PLATFORM_TYPE_SITE\",\n url=\"http://example.com/\",\n comment=\"\u041a\u043e\u043c\u043c\u0435\u043d\u0442\u0430\u0440\u0438\u0439 \u0438\u043b\u0438 \u043e\u043f\u0438\u0441\u0430\u043d\u0438\u0435\",\n)\n\nresponse = Platform.register_or_update_platform(platform_data)\nprint(response)\n\n# \u0420\u0435\u0433\u0438\u0441\u0442\u0440\u0430\u0446\u0438\u044f \u0438\u043b\u0438 \u043e\u0431\u043d\u043e\u0432\u043b\u0435\u043d\u0438\u0435 \u0434\u0430\u043d\u043d\u044b\u0445 \u0434\u043b\u044f \u043d\u0435\u0441\u043a\u043e\u043b\u044c\u043a\u0438\u0445 \u043f\u043b\u043e\u0449\u0430\u0434\u043e\u043a\nplatforms_data = BatchPlatformRequest(\n platforms=[\n PlatformRequest(\n appName=\"\u041d\u0430\u0437\u0432\u0430\u043d\u0438\u0435 \u043f\u043b\u043e\u0449\u0430\u0434\u043a\u0438 1\",\n externalPlatformId=\"example_id_12\",\n platformType=\"PLATFORM_TYPE_SITE\",\n url=\"http://example.com/app_one\",\n comment=\"Example comment for app one\",\n ),\n PlatformRequest(\n appName=\"\u041d\u0430\u0437\u0432\u0430\u043d\u0438\u0435 \u043f\u043b\u043e\u0449\u0430\u0434\u043a\u0438 2\",\n externalPlatformId=\"example_id_13\",\n platformType=\"PLATFORM_TYPE_SITE\",\n url=\"http://example.com/app_two\",\n comment=\"\u041a\u043e\u043c\u043c\u0435\u043d\u0442\u0430\u0440\u0438\u0439 \u0438\u043b\u0438 \u043e\u043f\u0438\u0441\u0430\u043d\u0438\u0435 1\",\n ),\n PlatformRequest(\n appName=\"Example App 34\",\n externalPlatformId=\"example_id_34\",\n platformType=\"PLATFORM_TYPE_SITE\",\n url=\"http://example.com/app_one\",\n comment=\"\u041a\u043e\u043c\u043c\u0435\u043d\u0442\u0430\u0440\u0438\u0439 \u0438\u043b\u0438 \u043e\u043f\u0438\u0441\u0430\u043d\u0438\u0435 2\",\n ),\n ]\n)\n\nresponse = Platform.register_or_update_multiple_platforms(platforms_data)\nprint(response)\n\n\n# \u0418\u043d\u0444\u043e\u0440\u043c\u0430\u0446\u0438\u044f \u043e \u043f\u043b\u043e\u0449\u0430\u0434\u043a\u0435\nexternalPlatformId = \"example_id_12\"\nresponse = Platform.get_platform_info(externalPlatformId)\nprint(response)\n\n\n# \u0421\u043f\u0438\u0441\u043e\u043a \u043f\u043b\u043e\u0449\u0430\u0434\u043e\u043a\nrequest_data = PlatformListRequest(\n cursor=PlatformCursor(\n externalId=\"\",\n updatedAt={},\n ),\n orderBy=\"ASC\",\n pageSize=0,\n)\n\nresponse = Platform.get_platform_list(request_data)\nprint(response)\n```\n\n### \u0414\u0440\u0443\u0433\u0438\u0435 \u043f\u0440\u0438\u043c\u0435\u0440\u044b\n\n\u0414\u0440\u0443\u0433\u0438\u0435 \u043f\u0440\u0438\u043c\u0435\u0440\u044b \u0432\u044b \u043d\u0430\u0439\u0434\u0435\u0442\u0435 \u0432 \u043f\u0430\u043f\u043a\u0435 **\"examples\"**.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Ozon \u041e\u0420\u0414 API - Python",
"version": "0.0.1b1",
"project_urls": {
"Homepage": "https://github.com/frollow/ozon-ord"
},
"split_keywords": [
"ozon",
" ord",
" ozon-ord",
" api",
" sdk",
" python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "af9b7017850d4a495ba5dff4f01f8a68d32aeb2c0608dee9708dd35786baa5e8",
"md5": "61057f84359123c4620df3e018914231",
"sha256": "7835487b01906cd6fc07006252b720c5bcdbacb541b9cc35d5292ddfa2608fa3"
},
"downloads": -1,
"filename": "ozon_ord-0.0.1b1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "61057f84359123c4620df3e018914231",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 14806,
"upload_time": "2024-04-27T15:42:01",
"upload_time_iso_8601": "2024-04-27T15:42:01.229352Z",
"url": "https://files.pythonhosted.org/packages/af/9b/7017850d4a495ba5dff4f01f8a68d32aeb2c0608dee9708dd35786baa5e8/ozon_ord-0.0.1b1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "eded9e9b6d1739e9213dd05c150b218dfd977106f68da8af4e94e086f6120b4e",
"md5": "798b0785a85e8bae094f8ccbf9b4737f",
"sha256": "a37045d90f1b7028fb41c7dbdac8d0dc843d19e400edd03a841e5cf869091522"
},
"downloads": -1,
"filename": "ozon_ord-0.0.1b1.tar.gz",
"has_sig": false,
"md5_digest": "798b0785a85e8bae094f8ccbf9b4737f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 10829,
"upload_time": "2024-04-27T15:42:03",
"upload_time_iso_8601": "2024-04-27T15:42:03.555969Z",
"url": "https://files.pythonhosted.org/packages/ed/ed/9e9b6d1739e9213dd05c150b218dfd977106f68da8af4e94e086f6120b4e/ozon_ord-0.0.1b1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-27 15:42:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "frollow",
"github_project": "ozon-ord",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "ozon-ord"
}
JSON
