GitFlic API

Компании

Описание структуры JSON-объекта, описывающего компанию
Поле Тип Описание
id string Уникальный ID компании
alias string Псевдоним компании
title string Название компании
description string Описание компании
url string Ссылка на сайт компании
contactPhone string Контактный телефон компании
contactEmail string Контактный email компании
ownerAlias string Псевдоним владельца компании
avatar string Ссылка на аватар компании
selectorTitle string Селектор названия компании
private boolean Приватная компания (true) или публичная (false)
selectorId string Селектор ID
selectorAlias string Селектор псевдонима компании
selectorOwnerAlias string Селектор псевдонима владельца компании
selectorColor string Селектор цвета
selectorHash string Селектор хэша

GET /company

Запрос возвращает массив компаний, есть возможность настройки количества отображаемых объектов на странице

Запрос Описание
GET /company Список компаний

Responses

STATUS 200 - пример JSON:

Пример ответа 
    
{
    "_embedded": {
        "companyList": [
            {
                "id": "7c7e495a-e4fd-413e-856e-68becefbde5f",
                "alias": "testovaya-kompaniya",
                "title": "тестовая компания",
                "description": "",
                "url": "test1.com",
                "contactPhone": null,
                "contactEmail": "user@gitflic.ru",
                "ownerAlias": "user1",
                "avatar": "https://gitflic.ru/upload/img/6c482659-8133-4961-bc54-d4086f2d8251.jpg",
                "selectorTitle": "тестовая компания",
                "private": false,
                "selectorId": "7c7e495a-e4fd-413e-856e-68becefbde5f",
                "selectorOwnerAlias": null,
                "selectorAlias": null,
                "selectorColor": null,
                "selectorHash": null
            },
            {
                "id": "f931a10b-ae36-4836-bcd2-16f4d4decda1",
                "alias": "publichnaya-kompaniya",
                "title": "публичная компания",
                "description": "",
                "url": null,
                "contactPhone": "+799792212249",
                "contactEmail": "user@gitflic.ru",
                "ownerAlias": "user1",
                "avatar": "https://gitflic.ru/upload/img/4b0fab04-4923-4cfa-aba0-ec70560fcae2.jpg",
                "selectorTitle": "публичная компания",
                "private": false,
                "selectorId": "f931a10b-ae36-4836-bcd2-16f4d4decda1",
                "selectorOwnerAlias": null,
                "selectorAlias": null,
                "selectorColor": null,
                "selectorHash": null
            }
        ]
    },
    "page": {
        "size": 10,
        "totalElements": 2,
        "totalPages": 1,
        "number": 0
    }
}


STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

GET /company/my

Запрос возвращает массив компаний, есть возможность настройки количества отображаемых объектов на странице

Запрос Описание
GET /company/my Список личных компаний

Responses

STATUS 200 - пример JSON:

Пример ответа 
    
{
    "_embedded": {
        "companyList": [
            {
                "id": "7c7e495a-e4fd-413e-856e-68becefbde5f",
                "alias": "gitflic",
                "title": "Гитфлик",
                "description": "Первый российский сервис для хранения исходного кода и работы с ним.",
                "url": "gitflic.ru",
                "contactPhone": null,
                "contactEmail": "user@gitflic.ru",
                "ownerAlias": "user1",
                "avatar": "https://gitflic.ru/upload/img/6c482659-8133-4961-bc54-d4086f2d8251.jpg",
                "selectorTitle": "Гитфлик",
                "private": false,
                "selectorId": "7c7e495a-e4fd-413e-856e-68becefbde5f",
                "selectorOwnerAlias": null,
                "selectorAlias": null,
                "selectorColor": null,
                "selectorHash": null
            },
            {
                "id": "f931a10b-ae36-4836-bcd2-16f4d4decda1",
                "alias": "publichnaya-kompaniya",
                "title": "публичная компания",
                "description": "",
                "url": null,
                "contactPhone": null,
                "contactEmail": "user@gitflic.ru",
                "ownerAlias": "user1",
                "avatar": "https://gitflic.ru/upload/img/4b0fab04-4923-4cfa-aba0-ec70560fcae2.jpg",
                "selectorTitle": "публичная компания",
                "private": false,
                "selectorId": "f931a10b-ae36-4836-bcd2-16f4d4decda1",
                "selectorOwnerAlias": null,
                "selectorAlias": null,
                "selectorColor": null,
                "selectorHash": null
            },
            {
                "id": "7f4829ba-f275-4336-acd1-ae416ce0c0db",
                "alias": "privatnaya-kompaniya",
                "title": "приватная компания",
                "description": "",
                "url": null,
                "contactPhone": null,
                "contactEmail": "user@gitflic.ru",
                "ownerAlias": "user1",
                "avatar": "https://gitflic.ru/upload/img/d6fef627-adb2-43b2-95ad-88f4fb54c6d2.jpg",
                "selectorTitle": "приватная компания",
                "private": true,
                "selectorId": "7f4829ba-f275-4336-acd1-ae416ce0c0db",
                "selectorOwnerAlias": null,
                "selectorAlias": null,
                "selectorColor": null,
                "selectorHash": null
            }
        ]
    },
    "page": {
        "size": 10,
        "totalElements": 3,
        "totalPages": 1,
        "number": 0
    }
}


STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

GET /company/{alias}

Запрос возвращает компанию

Запрос Описание
GET /company/{alias} Получить информацию о компании по alias

Responses

STATUS 200 - пример JSON:

{
    "id": "7f4829ba-f275-4336-acd1-ae416ce0c0db",
    "alias": "privatnaya-kompaniya",
    "title": "приватная компания",
    "description": "",
    "url": null,
    "contactPhone": null,
    "contactEmail": "user@gitflic.ru",
    "ownerAlias": "user1",
    "avatar": "https://gitflic.ru/upload/img/d6fef627-adb2-43b2-95ad-88f4fb54c6d2.jpg",
    "selectorTitle": "приватная компания",
    "private": true,
    "selectorId": "7f4829ba-f275-4336-acd1-ae416ce0c0db",
    "selectorOwnerAlias": null,
    "selectorAlias": null,
    "selectorColor": null,
    "selectorHash": null
}


STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

В данной статье

Все компаниии

Список собственных компаний

Сведения о компании по псевдониму

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