Общая информация
За исключением работы с токенами (см. статью про авторизацию) взаимодействие с остальным API происходит на языке запросов GraphQL.
- Базовый URL -
https://api.talantix.ru. - В запросе должен присутствовать заголовок
Content-type: application/json. - В запросе должен присутствовать авторизационный заголовок
Authorization: Bearer <your access token>. - В запросе должен присутствовать заголовок
User-Agent, в котором можно указать название компании и дополнительные свойства (например, контакты):
ООО "Хэдхантер" (email@hh.ru)
Данный заголовок будет использоваться для связи в случае различных проблем. - Дата/время возвращается в виде timestamp -
1703513801000- количество миллисекунд, прошедших с 1 января 1970 года по UTC. - Тело запроса и его ответ являются валидным JSON в кодировке UTF-8.
- В теле запроса обязано присутствовать поле
query. В нем передается один из корневых запросов, оформленный с учетом требований синтаксиса GraphQL.
Запрос в API может выглядеть следующим образом:
curl https://api.talantix.ru/graphql \
-X POST \
-H "Content-Type: application/json" \
-H "User-Agent: ООО "Хэдхантер" (email@hh.ru)" \
-H "Authorization: Bearer <your access token>" \
-d "{\"query\":\"query Me {me {id firstName lastName middleName email}}\"}"
Документация содержит разделы с примерами запросов и описанием особенностей GraphQL.
При возникновении предложений, вопросов или проблем в работе API обращайтесь в техническую поддержку Talantix
Для эффективного решения вашего вопроса прикладывайте к обращению значение заголовка X-Request-Id из проблемного ответа API
Playground
Для удобного тестирования GraphQL API запросов можно использовать Playground. Чтобы выполнить запрос, необходимо вставить свой access токен во вкладке Headers. Каждый пример запроса в данной документации имеет быструю ссылку, чтобы его можно было сразу проверить в Playground.
Получение схемы
Описание схемы GraphQL API Talantix можно получить, выполнив запрос интроспекции на url /graphql/schema (см. описание интроспекции).
Большинство библиотек для работы с GraphQL для различных языков программирования умеют строить запрос интроспекции самостоятельно, обращайтесь к документации конкретной библиотеки.