gmdgmdText
gmdgmdText

Бесплатно скачайте приложение сейчас, чтобы всегда знать, где находится ваш ребёнок

Partner API

Ориентировки: получение заявок

Спецификация для партнеров, которые получают активные заявки о пропавших детях и показывают их пользователям в согласованном кобрендинговом формате.

GET /poi/v1/getWebsiteActiveAmberAlertsGET /poi/v1/getAmberAlertsPointsGET /poi/v1/getAmberAlert

Как работает API

Федеральный фид

GET /poi/v1/getWebsiteActiveAmberAlerts

Полный список опубликованных активных ориентировок для серверной синхронизации и отбора релевантных регионов на стороне партнера. Требуется токен.

Точки в области карты

GET /poi/v1/getAmberAlertsPoints

Координаты и pointId внутри bbox для карт, региональных витрин и сценариев без загрузки полного списка. Требуется токен.

Карточка по ID

GET /poi/v1/getAmberAlert

Детальная карточка ориентировки: фото, описание, возраст, место последнего появления, статус и контактные данные по соглашению. Требуется токен.

Доступ и синхронизация

Партнер получает токен доступа и передает его в query-параметре u. Токен обязателен для всех методов API.
Запросы выполняются только по схеме server-to-server. Не встраивайте токен в браузерный или мобильный клиент.
Рекомендуем синхронизировать федеральный фид не чаще одного раза в 15 минут и обслуживать пользователей из своего кеша между синхронизациями.
Карточки по pointId запрашивайте по мере необходимости, а не для всего фида целиком: список активных ориентировок уже содержит нужные для витрины поля.

Ошибки

  • error: 2Токен не передан или недействителен. Такой ответ приходит с HTTP 200, поэтому проверяйте поле error, а не только HTTP-статус.
  • error: 10000Внутренняя ошибка сервиса. Запрос можно повторить позже, данные партнера при этом не меняются.

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

Забрать активные заявки

Запрос
curl 'https://api.gdemoideti.ru/poi/v1/getWebsiteActiveAmberAlerts?u={partner_token}'
Ответ
{
  "error": 0,
  "errorText": "",
  "instance": "apps-6d8cd5947c-8jngp",
  "release": "v1-1-1",
  "execTime": 0.12,
  "result": [
    {
      "pointId": 12345,
      "expirationDate": 1716201563,
      "parentId": 98765,
      "childName": "Михаил",
      "childAge": 13,
      "missingDate": 1715769563,
      "location": { "lat": 58.0105, "long": 56.2502 },
      "address": "г. Пермь, ул. Красноармейская, 12",
      "childDescription": "Был одет в джинсовку и джинсы",
      "childPhoto": "https://example.com/photo.png",
      "status": "PUBLISHED",
      "description": "Дополнительная информация по поиску",
      "phone": "+7 999 123-12-12"
    }
  ]
}

Получить точки по bbox

Запрос
curl 'https://api.gdemoideti.ru/poi/v1/getAmberAlertsPoints?u={partner_token}&latBottom=55.55&longBottom=37.35&latUp=55.95&longUp=37.95'
Ответ
{
  "error": 0,
  "errorText": "",
  "instance": "apps-6d8cd5947c-8jngp",
  "release": "v1-1-1",
  "execTime": 0.08,
  "result": [
    {
      "location": { "lat": 55.7512, "long": 37.6184 },
      "pointId": 12345
    }
  ]
}

Открыть карточку

Запрос
curl 'https://api.gdemoideti.ru/poi/v1/getAmberAlert?u={partner_token}&pointId=12345'
Ответ
{
  "error": 0,
  "errorText": "",
  "instance": "apps-6d8cd5947c-8jngp",
  "release": "v1-1-1",
  "execTime": 0.06,
  "result": {
    "pointId": 12345,
    "expirationDate": 1716201563,
    "parentId": 98765,
    "childName": "Михаил",
    "childAge": 13,
    "missingDate": 1715769563,
    "location": { "lat": 58.0105, "long": 56.2502 },
    "address": "г. Пермь, ул. Красноармейская, 12",
    "childDescription": "Был одет в джинсовку и джинсы",
    "childPhoto": "https://example.com/photo.png",
    "status": "PUBLISHED",
    "description": "Дополнительная информация по поиску",
    "phone": "+7 999 123-12-12"
  }
}

Правила использования

Ответы приходят в JSON envelope: error, errorText, instance, release, execTime и result. Успешным считается ответ с error равным 0.
В партнерских методах возвращаются только опубликованные заявки, поэтому поле status всегда содержит PUBLISHED.
После снятия с публикации ориентировка пропадает из фида, а ее карточка по pointId перестает возвращаться. Считайте отсутствие заявки в свежем фиде сигналом прекратить ее распространение и удалить из активных кешей.
OpenAPI YAML можно использовать для автоматической генерации клиентских библиотек, мок-серверов, коллекций для Postman и Insomnia, а также для автоматических проверок соответствия API контракту.
Координаты передаются в WGS 84, поля называются lat и long.
parentId и phone относятся к чувствительным данным и используются только в рамках соглашения.
Подключение

Получить доступ к API

Напишите нам, чтобы согласовать сценарий, получить токен и проверить интеграцию перед запуском.

partners@gdemoideti.ru