Страницы¶
Получение списка типов страниц¶
Метод: GET
URL: https://beta.api.gigma.ru/counterparty/pages
Авторизация: -
Headers: Token: {токен приложения из Gigma}
Параметры запроса¶
Передаваемые параметры отсутствуют.
Пример запроса¶
https://beta.api.gigma.ru/counterparty/page_types
Ответ¶
При успешном действии возвращается HTTP код 200.
{
"items": [
{
"id": 1,
"name": "Страница",
"photo": null,
"created_at": "2024-11-01T19:09:36.000000Z"
},
{
"id": 2,
"name": "Блок",
"photo": null,
"created_at": "2024-11-01T19:09:36.000000Z"
},
{
"id": 3,
"name": "Новость",
"photo": null,
"created_at": "2024-11-01T19:09:36.000000Z"
}
],
"itemsCount": 3
}
Описание полей ответа¶
id- ID типа страницы;name- название типа страницы;
Получение списка страниц¶
Метод: GET
URL: https://beta.api.gigma.ru/counterparty/pages
Авторизация: -
Headers: Token: {токен приложения из Gigma}
Параметры запроса¶
page_type_id- ID типа страницы из справочника из запроса
Пример запроса¶
https://beta.api.gigma.ru/counterparty/pages?page_type_id=3
Ответ¶
При успешном действии возвращается HTTP код 200.
{
"pages": [
{
"id": 9,
"slug": "new-1",
"title": "Новость 1",
"description": null,
"preview": {
"id": 3,
"name": "Container.svg",
"type": {
"id": 1,
"name": "Трудовой договор",
"avatar": "https:\/\/beta.back.erp.itecho.ru\/storage\/uploads\/default.svg",
"created_at": "2024-03-27T07:00:46.000000Z"
},
"path": "https:\/\/beta.back.erp.itecho.ru\/storage\/uploads\/J89936UEJYHmqaWyN8TA2JfTfFHWGvt2jequMsyd.svg",
"link": null,
"created_at": "2024-04-18T13:37:45.000000Z",
"updated_at": "2024-04-18T13:37:45.000000Z"
},
"content": "<!DOCTYPE HTML>\n<html lang=\"en\">\n <head>\n <meta charset=\"utf-8\">\n <meta name=\"description\" content=\"A page for exploring basic HTML documents\">\n <title>Basic HTML document<\/title>\n <\/head>\n <body>\n <h1>Page content<\/h1>\n <p>The main page content appears inside the <b>body<\/b> tag. HTML contains several elements that allow you to properly structure and format your content, which we'll cover later.<\/p>\n <\/body>\n<\/html>",
"created_at": "2024-05-13T05:29:39.000000Z"
},
{
"id": 10,
"slug": "new-2",
"title": "Новость 2",
"description": null,
"preview": {
"id": 3,
"name": "Container.svg",
"type": {
"id": 1,
"name": "Трудовой договор",
"avatar": "https:\/\/beta.back.erp.itecho.ru\/storage\/uploads\/default.svg",
"created_at": "2024-03-27T07:00:46.000000Z"
},
"path": "https:\/\/beta.back.erp.itecho.ru\/storage\/uploads\/J89936UEJYHmqaWyN8TA2JfTfFHWGvt2jequMsyd.svg",
"link": null,
"created_at": "2024-04-18T13:37:45.000000Z",
"updated_at": "2024-04-18T13:37:45.000000Z"
},
"content": "<!DOCTYPE HTML>\n<html lang=\"en\">\n <head>\n <meta charset=\"utf-8\">\n <meta name=\"description\" content=\"A page for exploring basic HTML documents\">\n <title>Basic HTML document<\/title>\n <\/head>\n <body>\n <h1>Page content<\/h1>\n <p>The main page content appears inside the <b>body<\/b> tag. HTML contains several elements that allow you to properly structure and format your content, which we'll cover later.<\/p>\n <\/body>\n<\/html>",
"created_at": "2024-05-13T05:29:39.000000Z"
}
],
"pagesCount": 2
}
Описание полей ответа¶
id- ID пункта меню;avatar- URL ссылка на аватар элемента меню;name- название пункта меню;url- ссылка для перехода и/или загрузки HTML содержимого страницы из запроса;children- массив дочерних элементов меню.
Получение выбранной страницы¶
Метод: GET
URL: https://beta.api.gigma.ru/counterparty/pages/{slug}
Авторизация: -
Headers: Token: {токен приложения из Gigma}
Параметры запроса¶
Передаваемые параметры отсутствуют.
Пример запроса¶
https://beta.api.gigma.ru/counterparty/pages/new-1
Ответ¶
При успешном действии возвращается HTTP код 200.
{
"page": {
"id": 9,
"slug": "new-1",
"title": "Новость 1",
"description": null,
"preview": {
"id": 3,
"name": "Container.svg",
"type": {
"id": 1,
"name": "Трудовой договор",
"avatar": "https:\/\/beta.back.erp.itecho.ru\/storage\/uploads\/default.svg",
"created_at": "2024-03-27T07:00:46.000000Z"
},
"path": "https:\/\/beta.back.erp.itecho.ru\/storage\/uploads\/J89936UEJYHmqaWyN8TA2JfTfFHWGvt2jequMsyd.svg",
"link": null,
"created_at": "2024-04-18T13:37:45.000000Z",
"updated_at": "2024-04-18T13:37:45.000000Z"
},
"content": "<!DOCTYPE HTML>\n<html lang=\"en\">\n <head>\n <meta charset=\"utf-8\">\n <meta name=\"description\" content=\"A page for exploring basic HTML documents\">\n <title>Basic HTML document<\/title>\n <\/head>\n <body>\n <h1>Page content<\/h1>\n <p>The main page content appears inside the <b>body<\/b> tag. HTML contains several elements that allow you to properly structure and format your content, which we'll cover later.<\/p>\n <\/body>\n<\/html>",
"created_at": "2024-05-13T05:29:39.000000Z"
}
}
Описание полей ответа¶
id- ID пункта меню;avatar- URL ссылка на аватар элемента меню;name- название пункта меню;url- ссылка для перехода и/или загрузки HTML содержимого страницы из запроса;children- массив дочерних элементов меню.