Skip to content
master
Switch branches/tags
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
v3
 
 
 
 

API сервиса Контрагентио

Контрагентио API – это SaaS-сервис для автоматического получения сведений о российских организациях (ЮЛ и ИП) и проявления должной осмотрительности при выборе контрагентов.

Общие сведения

  • Базовый URL для методов API расположен по адресу https://api.kontragent.io/v3/graphql
  • Обмен данными с сервисом осуществляется по протоколу HTTPS.
  • Формат данных запроса – GraphQL.
  • Формат данных ответа – JSON.
  • Параметры в запроса должны быть в кодировке UTF-8 и закодированы для передачи в URL (http://en.wikipedia.org/wiki/Percent-encoding).

Начало работы с GraphQL

С точки зрения технологий работа с языком запросов GraphQL ничем не отличается от работы с обычным REST API, но если вы не знакомы с GraphQL, то рекомендуем ознакомиться со следующими материалами:

Аутентификация

Для доступа к методам сервиса требуется передавать аутентификационный JWT-токен в заголовке Authorization по схеме Bearer (при работе с песочницей токен необходимо указать в поле "Токен авторизации"). Для получения токена напишите нам на sales@kontragent.io.

Работа с песочницей

Для того, чтобы вам было удобнее тестировать свои запросы, мы подготовили специальную песочницу, которая расположена по адресу https://sandbox.kontragent.io. Песочница позволяет использовать средства автокомплита, автоматической валидации и форматирования запросов. Для получения подсказок по возможным полям запроса нажмите Shift + Пробел или Ctrl + Пробел.

Программное взаимодействие с API

Чтобы запросить данные у GraphQL API из вашей информационной системы, вам достаточно отправить POST-запрос. Пример простого запроса, который получит полное наименование для организации с ОГРН 1047796788930 с помощью CURL:

curl -X POST \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer YOUR-API-TOKEN-HERE" \
     -d '
        {
          "query": "query someRandomQueryName($ogrn: String) { company(ogrn: $ogrn) { fullName } }",
          "variables": {
            "ogrn": "1047796788930"
          },
          "operationName": "someRandomQueryName"
        }
     ' \
     https://api.kontragent.io/v3/graphql

Методы и документация

Полная документация ко всем методам расположена в песочнице. Для того, чтобы получить сведения об интересующих данных, нажмите на вкладку Docs в правом верхнем углу экрана.

Далее приведены ссылки на примеры получения некоторых данных:

Контакты и техподдержка

Для получения токена доступа к API напишите нам на sales@kontragent.io По вопросам работы с API обращайтесь на support@kontragent.io

Changelog

23 января 2020 г.

23 июля 2019 г.

About

Описание формата API ЕГРЮЛ и ЕГРИП сервиса Контрагентио

Resources

Releases

No releases published

Packages

No packages published