Компании

Управление компаниями в API Pact v1

Компании

Заметка

У каждого пользователя может быть несколько компаний. У каждого пользователя должна быть хотя бы одна компания в системе.

Получить все компании

shell

curl "https://api.pact.im/p1/companies"
  -H "X-Private-Api-Token: YOUR_API_TOKEN"

curl "https://api.pact.im/p1/companies"
  -H "X-Private-Api-Token: YOUR_API_TOKEN"

Приведённая выше команда возвращает JSON следующей структуры:

json

{
   "status":"ok",
   "data":{
      "companies":[
         {
            "external_id":1,
            "name":"COMPANY_NAME",
            "phone":null,
            "description":null,
            "webhook_url":null
         }
      ],
      "next_page": "fslkfg2lkdfmlwkmlmw4of94wg34lfkm34lg"
   }
}

{
   "status":"ok",
   "data":{
      "companies":[
         {
            "external_id":1,
            "name":"COMPANY_NAME",
            "phone":null,
            "description":null,
            "webhook_url":null
         }
      ],
      "next_page": "fslkfg2lkdfmlwkmlmw4of94wg34lfkm34lg"
   }
}

Этот эндпоинт возвращает список всех компаний пользователя.

HTTP Request

GET https://api.pact.im/p1/companies

Параметры запроса

Параметр	Обязательный	Валидация	Описание
from	нет	Строка не длиннее 255 символов	Токен следующей страницы, полученный в предыдущем запросе. Если токен неверный или пустой, возвращается первая страница
per	нет	Число от 1 до 100	Количество элементов на странице. По умолчанию: 50
sort_direction	нет	Строка	Результаты сортируются по id. Позволяет изменить направление сортировки. Допустимые значения: asc, desc. По умолчанию: asc.

Обновить компанию

shell

curl -X PUT "https://api.pact.im/p1/companies/ID"
  -H "X-Private-Api-Token: YOUR_API_TOKEN"
  -d "name=Test"

curl -X PUT "https://api.pact.im/p1/companies/ID"
  -H "X-Private-Api-Token: YOUR_API_TOKEN"
  -d "name=Test"

Приведённая выше команда возвращает JSON следующей структуры:

json

{
   "status":"updated",
   "data":{
      "external_id":2
   }
}

{
   "status":"updated",
   "data":{
      "external_id":2
   }
}

Этот эндпоинт обновляет отдельные атрибуты компании.

HTTP Request

PUT https://api.pact.im/p1/companies/<ID>

Параметры URL

Параметр	Описание
ID	ID обновляемой компании

Параметры запроса

Параметр	Обязательный	Валидация	Описание
name	нет	Строка не длиннее 255 символов	Название компании
phone	нет	Строка	Официальный телефон компании или телефон контактного лица
description	нет	Строка	Описание компании
webhook_url	нет	Строка	Адрес для приёма вебхуков
hidden	нет	Логическое значение	Скрыть/показать компанию в веб-интерфейсе Pact

Заметка

Если вы хотите получать вебхуки, убедитесь, что указан webhook_url. URL вебхука должен быть корректным, а код ответа на POST json-запрос {'source':'pact.im', 'operation':'test'} должен быть 200

Создать новую компанию

shell

curl -X POST "https://api.pact.im/p1/companies"
  -H "X-Private-Api-Token: YOUR_API_TOKEN"
  -d "name=Test"

curl -X POST "https://api.pact.im/p1/companies"
  -H "X-Private-Api-Token: YOUR_API_TOKEN"
  -d "name=Test"

Приведённая выше команда возвращает JSON следующей структуры:

json

{
   "status":"created",
   "data":{
      "external_id":2
   }
}

{
   "status":"created",
   "data":{
      "external_id":2
   }
}

Этот эндпоинт создаёт новую компанию для пользователя.

HTTP Request

POST https://api.pact.im/p1/companies

Параметры запроса

Параметр	Обязательный	Валидация	Описание
name	да	Строка не длиннее 255 символов	Название компании
phone	нет	Строка	Официальный телефон компании или телефон контактного лица
description	нет	Строка	Описание компании
webhook_url	нет	Строка	Доступный в интернете адрес, который может принимать вебхуки

Заметка

Компании