guild/docs/api/main.md
2021-07-03 15:28:03 +03:00

3.2 KiB

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

Навыки

Популярные навыки

https://guild.craft-group.xyz/api/skills/skills-on-main-page

Чтобы получить популярные навыки нужно сделать GET запрос на URL https://guild.craft-group.xyz/api/skills/skills-on-main-page

Профиль

Список

https://guild.craft-group.xyz/api/profile

Для получения списка профилей необходимо отправить GET запрос на URL https://guild.craft-group.xyz/api/profile

Возможные параметры:

Параметры Значение
limit Количество профилей, которое вернет сервер при запроск.
offset Количество записей на которое нужно отчтупить в списке профилей.
skills Идентификаторы навыков по которым нужно отфильтровать профили.

Пример запроса:

https://guild.craft-group.xyz/api/profile?limit=5&offset=5&skills=1

Одна запись

https://guild.craft-group.xyz/api/profile/{id}

Для того, чтобы получить данные одной записи необходимо отправить GET запрос на URL https://guild.craft-group.xyz/api/profile/{id} , где id это идинтификатор профиля.

Пример запроса:

https://guild.craft-group.xyz/api/profile/6

Пригласить на собеседование

https://guild.craft-group.xyz/api/profile/add-to-interview

Для того, отправить приглашение профилю на собеседование, необходимо сделать POST запрос на URL https://guild.craft-group.xyz/api/profile/add-to-interview

Возможные параметры:

Параметры Значение
email* Почта пользователя, который хочет пригласить на собеседование.
profile_id* Идентификатор профиля.
phone Телефон
comment Дополнительные пожелания по собеседованию.