Справочник API
Спецификация OpenAPI
Twins API (1.0)
Сервис предоставляет связи объектов между 2ГИС и внешними мастер-системами
Получить связи объектов по идентификаторам 2ГИС
Метод ищет одинаковые объекты у партнёров по идентификаторам 2ГИС.
Метод не вернёт результат, если нет доступа к одному из партнёров.
Authorizations:
partner_key
query Parameters
| dgis_id | Array of strings [ 1 .. 50 ] items Example: dgis_id=12345 Идентификаторы объектов 2ГИС |
| partner_code | Array of strings [ 1 .. 5 ] items Items Enum: "afisha" "delivery-club" "sber-atms" "sber-offices" "sber-terminals" "sber-food" "sber-spasibo" "sber-ryadom" Коды партнёров |
Responses
Response Schema: application/json
required | object |
required | object |
Response samples
- 200
- 400
- 401
- 403
- 429
- 500
Content type
application/json
{- "meta": {
- "code": 200,
- "message": "ok"
}, - "result": {
- "items": [
- {
- "dgis_id": 12345,
- "dgis_type": "branch",
- "twins": [
- {
- "partner_id": 67890,
- "partner_code": "partner1",
- "partner_type": "branch"
}
]
}
], - "total": 1
}
}Получить связи объектов по идентификаторам партнёра
Метод ищет одинаковые объекты в 2ГИС по идентификаторам партнёра.
Метод не вернёт результат, если нет доступа к партнёру.
Authorizations:
partner_key
query Parameters
| partner_code | string Enum: "afisha" "delivery-club" "sber-atms" "sber-offices" "sber-terminals" "sber-food" "sber-spasibo" "sber-ryadom" Код партнёра |
| partner_id | Array of strings [ 1 .. 50 ] items Example: partner_id=12345 Идентификаторы объектов партнёра |
Responses
Response Schema: application/json
required | object |
required | object |
Response samples
- 200
- 400
- 401
- 403
- 429
- 500
Content type
application/json
{- "meta": {
- "code": 200,
- "message": "ok"
}, - "result": {
- "items": [
- {
- "partner_id": 12345,
- "partner_type": "branch",
- "twins": [
- {
- "dgis_id": 67890,
- "dgis_type": "branch"
}
]
}
], - "total": 1
}
}Получить все связи объектов партнёра
Authorizations:
partner_key
query Parameters
| partner_code | string Enum: "afisha" "delivery-club" "sber-atms" "sber-offices" "sber-terminals" "sber-food" "sber-spasibo" "sber-ryadom" Код партнёра |
Responses
Response Schema: text/csv
string (SuccessfulExportResponse)
Response samples
- 400
- 401
- 403
- 429
- 500
Content type
application/json
{- "meta": {
- "code": 400,
- "message": "invalid params"
}
}