Найти координаты адреса по подсказкам

Порядок работы для агента · Методы API и схема OpenAPI.

Назначение

Найдите варианты адреса по строке geocode. Смотрите результаты в data.response.GeoObjectCollection.featureMember и уточните адрес у пользователя, если подходят несколько вариантов.

Блоки запроса и ответов ниже сгенерированы из OpenAPI. Подстановки вроде example показывают структуру JSON. Для вызова возьмите значения из сценария, справочников или предыдущих ответов API.

Request

GET

https://partner-test-yamagistrali.ru/api/geocoder/yaProxy/v1

Тестовый стенд

Query parameters

Name

Description

geocode

Type: string

Адрес для поиска

Min length: 1

Example: ``

Responses

200 OK

Body

application/json

{
  "data": {
    "response": {
      "GeoObjectCollection": {
        "featureMember": [
          {}
        ],
        "metaDataProperty": {
          "GeocoderResponseMetaData": {}
        }
      }
    }
  }
}

Name

Description

data

Type: GeocoderYaProxyV1Response

Example

{
  "response": {
    "GeoObjectCollection": {
      "featureMember": [
        {
          "GeoObject": {}
        }
      ],
      "metaDataProperty": {
        "GeocoderResponseMetaData": {
          "found": "example",
          "request": "example",
          "results": "example"
        }
      }
    }
  }
}

GeocoderYaProxyV1Point

Name

Description

pos

Type: string

Example: example

Example

{
  "pos": "example"
}

GeocoderYaProxyV1Envelope

Name

Description

lowerCorner

Type: string

Example: example

upperCorner

Type: string

Example: example

Example

{
  "lowerCorner": "example",
  "upperCorner": "example"
}

GeocoderYaProxyV1BoundedBy

Name	Description
Envelope	Type: GeocoderYaProxyV1Envelope Example `{ "lowerCorner": "example", "upperCorner": "example" }`

Example

{
  "Envelope": {
    "lowerCorner": "example",
    "upperCorner": "example"
  }
}

GeocoderYaProxyV1AddressComponent

Name

Description

kind

Type: string

Example: example

name

Type: string

Example: example

Example

{
  "kind": "example",
  "name": "example"
}

GeocoderYaProxyV1Address

Name	Description
country_code	Type: string Example: `example`
formatted	Type: string Example: `example`
postal_code	Type: string Example: `example`
Components	Type: GeocoderYaProxyV1AddressComponent[] \| null Example `[ { "kind": "example", "name": "example" } ]`

Example

{
  "Components": [
    {
      "kind": "example",
      "name": "example"
    }
  ],
  "country_code": "example",
  "formatted": "example",
  "postal_code": "example"
}

GeocoderYaProxyV1GeocoderMetaData

Name	Description
Address	Type: GeocoderYaProxyV1Address Example `{ "Components": [ { "kind": "example", "name": "example" } ], "country_code": "example", "formatted": "example", "postal_code": "example" }`
kind	Type: string Example: `example`
precision	Type: string Example: `example`
text	Type: string Example: `example`

Example

{
  "Address": {
    "Components": [
      {
        "kind": "example",
        "name": "example"
      }
    ],
    "country_code": "example",
    "formatted": "example",
    "postal_code": "example"
  },
  "kind": "example",
  "precision": "example",
  "text": "example"
}

GeocoderYaProxyV1GeoObjectMetaDataProperty

Name

Description

GeocoderMetaData

Type: GeocoderYaProxyV1GeocoderMetaData

Example

{
  "Address": {
    "Components": [
      {
        "kind": "example",
        "name": "example"
      }
    ],
    "country_code": "example",
    "formatted": "example",
    "postal_code": "example"
  },
  "kind": "example",
  "precision": "example",
  "text": "example"
}

Example

{
  "GeocoderMetaData": {
    "Address": {
      "Components": [
        {
          "kind": "example",
          "name": "example"
        }
      ],
      "country_code": "example",
      "formatted": "example",
      "postal_code": "example"
    },
    "kind": "example",
    "precision": "example",
    "text": "example"
  }
}

GeocoderYaProxyV1GeoObject

Name	Description
boundedBy	Type: GeocoderYaProxyV1BoundedBy Example `{ "Envelope": { "lowerCorner": "example", "upperCorner": "example" } }`
description	Type: string Example: `example`
metaDataProperty	Type: GeocoderYaProxyV1GeoObjectMetaDataProperty Example `{ "GeocoderMetaData": { "Address": { "Components": [ { "kind": "example", "name": "example" } ], "country_code": "example", "formatted": "example", "postal_code": "example" }, "kind": "example", "precision": "example", "text": "example" } }`
name	Type: string Example: `example`
Point	Type: GeocoderYaProxyV1Point Example `{ "pos": "example" }`
uri	Type: string Example: `example`

Example

{
  "Point": {
    "pos": "example"
  },
  "boundedBy": {
    "Envelope": {
      "lowerCorner": "example",
      "upperCorner": "example"
    }
  },
  "description": "example",
  "metaDataProperty": {
    "GeocoderMetaData": {
      "Address": {
        "Components": [
          {}
        ],
        "country_code": "example",
        "formatted": "example",
        "postal_code": "example"
      },
      "kind": "example",
      "precision": "example",
      "text": "example"
    }
  },
  "name": "example",
  "uri": "example"
}

GeocoderYaProxyV1FeatureMember

Name

Description

GeoObject

Type: GeocoderYaProxyV1GeoObject

Example

{
  "Point": {
    "pos": "example"
  },
  "boundedBy": {
    "Envelope": {
      "lowerCorner": "example",
      "upperCorner": "example"
    }
  },
  "description": "example",
  "metaDataProperty": {
    "GeocoderMetaData": {
      "Address": {
        "Components": [
          {}
        ],
        "country_code": "example",
        "formatted": "example",
        "postal_code": "example"
      },
      "kind": "example",
      "precision": "example",
      "text": "example"
    }
  },
  "name": "example",
  "uri": "example"
}

Example

{
  "GeoObject": {
    "Point": {
      "pos": "example"
    },
    "boundedBy": {
      "Envelope": {
        "lowerCorner": "example",
        "upperCorner": "example"
      }
    },
    "description": "example",
    "metaDataProperty": {
      "GeocoderMetaData": {
        "Address": {
          "Components": [
            null
          ],
          "country_code": "example",
          "formatted": "example",
          "postal_code": "example"
        },
        "kind": "example",
        "precision": "example",
        "text": "example"
      }
    },
    "name": "example",
    "uri": "example"
  }
}

GeocoderYaProxyV1GeocoderResponseMetaData

Name	Description
found	Type: string Example: `example`
request	Type: string Example: `example`
results	Type: string Example: `example`

Example

{
  "found": "example",
  "request": "example",
  "results": "example"
}

GeocoderYaProxyV1CollectionMetaDataProperty

Name	Description
GeocoderResponseMetaData	Type: GeocoderYaProxyV1GeocoderResponseMetaData Example `{ "found": "example", "request": "example", "results": "example" }`

Example

{
  "GeocoderResponseMetaData": {
    "found": "example",
    "request": "example",
    "results": "example"
  }
}

GeocoderYaProxyV1GeoObjectCollection

Name

Description

metaDataProperty

Type: GeocoderYaProxyV1CollectionMetaDataProperty

Example

{
  "GeocoderResponseMetaData": {
    "found": "example",
    "request": "example",
    "results": "example"
  }
}

featureMember

Type: GeocoderYaProxyV1FeatureMember[] | null

Example

[
  {
    "GeoObject": {
      "Point": {
        "pos": "example"
      },
      "boundedBy": {
        "Envelope": {
          "lowerCorner": "example",
          "upperCorner": "example"
        }
      },
      "description": "example",
      "metaDataProperty": {
        "GeocoderMetaData": {
          "Address": {},
          "kind": "example",
          "precision": "example",
          "text": "example"
        }
      },
      "name": "example",
      "uri": "example"
    }
  }
]

Example

{
  "featureMember": [
    {
      "GeoObject": {
        "Point": {
          "pos": "example"
        },
        "boundedBy": {
          "Envelope": {}
        },
        "description": "example",
        "metaDataProperty": {
          "GeocoderMetaData": {}
        },
        "name": "example",
        "uri": "example"
      }
    }
  ],
  "metaDataProperty": {
    "GeocoderResponseMetaData": {
      "found": "example",
      "request": "example",
      "results": "example"
    }
  }
}

GeocoderYaProxyV1ResponseData

Name

Description

GeoObjectCollection

Type: GeocoderYaProxyV1GeoObjectCollection

Example

{
  "featureMember": [
    {
      "GeoObject": {
        "Point": {
          "pos": "example"
        },
        "boundedBy": {
          "Envelope": {}
        },
        "description": "example",
        "metaDataProperty": {
          "GeocoderMetaData": {}
        },
        "name": "example",
        "uri": "example"
      }
    }
  ],
  "metaDataProperty": {
    "GeocoderResponseMetaData": {
      "found": "example",
      "request": "example",
      "results": "example"
    }
  }
}

Example

{
  "GeoObjectCollection": {
    "featureMember": [
      {
        "GeoObject": {
          "Point": {},
          "boundedBy": {},
          "description": "example",
          "metaDataProperty": {},
          "name": "example",
          "uri": "example"
        }
      }
    ],
    "metaDataProperty": {
      "GeocoderResponseMetaData": {
        "found": "example",
        "request": "example",
        "results": "example"
      }
    }
  }
}

GeocoderYaProxyV1Response

Name

Description

response

Type: GeocoderYaProxyV1ResponseData

Example

{
  "GeoObjectCollection": {
    "featureMember": [
      {
        "GeoObject": {
          "Point": {},
          "boundedBy": {},
          "description": "example",
          "metaDataProperty": {},
          "name": "example",
          "uri": "example"
        }
      }
    ],
    "metaDataProperty": {
      "GeocoderResponseMetaData": {
        "found": "example",
        "request": "example",
        "results": "example"
      }
    }
  }
}

Example

{
  "response": {
    "GeoObjectCollection": {
      "featureMember": [
        {
          "GeoObject": {}
        }
      ],
      "metaDataProperty": {
        "GeocoderResponseMetaData": {
          "found": "example",
          "request": "example",
          "results": "example"
        }
      }
    }
  }
}

400 Bad Request

Bad Request

Body

application/json

{
  "error": {
    "info": {},
    "message": "example",
    "message_code": "example"
  }
}

Name	Description
error	Type: Error Example `{ "info": {}, "message": "example", "message_code": "example" }`

Error

Name	Description
info	Type: object Example `{}`
message	Type: string Example: `example`
message_code	Type: string Example: `example`

Example

{
  "info": {},
  "message": "example",
  "message_code": "example"
}

403 Forbidden

Forbidden

Body

application/json

{
  "error": {
    "info": {},
    "message": "example",
    "message_code": "example"
  }
}

Name	Description
error	Type: Error Example `{ "info": {}, "message": "example", "message_code": "example" }`

500 Internal Server Error

Internal Server Error

Body

application/json

{
  "error": {
    "info": {},
    "message": "example",
    "message_code": "example"
  }
}

Name	Description
error	Type: Error Example `{ "info": {}, "message": "example", "message_code": "example" }`

Найти координаты по адресу

Найти узловые точки по адресу

Найти координаты адреса по подсказкам

НазначениеНазначение

RequestRequest

Query parametersQuery parameters

ResponsesResponses

200 OK200 OK

BodyBody

GeocoderYaProxyV1PointGeocoderYaProxyV1Point

GeocoderYaProxyV1EnvelopeGeocoderYaProxyV1Envelope

GeocoderYaProxyV1BoundedByGeocoderYaProxyV1BoundedBy

GeocoderYaProxyV1AddressComponentGeocoderYaProxyV1AddressComponent

GeocoderYaProxyV1AddressGeocoderYaProxyV1Address

GeocoderYaProxyV1GeocoderMetaDataGeocoderYaProxyV1GeocoderMetaData

GeocoderYaProxyV1GeoObjectMetaDataPropertyGeocoderYaProxyV1GeoObjectMetaDataProperty

GeocoderYaProxyV1GeoObjectGeocoderYaProxyV1GeoObject

GeocoderYaProxyV1FeatureMemberGeocoderYaProxyV1FeatureMember

GeocoderYaProxyV1GeocoderResponseMetaDataGeocoderYaProxyV1GeocoderResponseMetaData

GeocoderYaProxyV1CollectionMetaDataPropertyGeocoderYaProxyV1CollectionMetaDataProperty

GeocoderYaProxyV1GeoObjectCollectionGeocoderYaProxyV1GeoObjectCollection

GeocoderYaProxyV1ResponseDataGeocoderYaProxyV1ResponseData

GeocoderYaProxyV1ResponseGeocoderYaProxyV1Response

400 Bad Request400 Bad Request

BodyBody

ErrorError

403 Forbidden403 Forbidden

BodyBody

500 Internal Server Error500 Internal Server Error

BodyBody

Назначение

Request

Query parameters

Responses

200 OK

Body

GeocoderYaProxyV1Point

GeocoderYaProxyV1Envelope

GeocoderYaProxyV1BoundedBy

GeocoderYaProxyV1AddressComponent

GeocoderYaProxyV1Address

GeocoderYaProxyV1GeocoderMetaData

GeocoderYaProxyV1GeoObjectMetaDataProperty

GeocoderYaProxyV1GeoObject

GeocoderYaProxyV1FeatureMember

GeocoderYaProxyV1GeocoderResponseMetaData

GeocoderYaProxyV1CollectionMetaDataProperty

GeocoderYaProxyV1GeoObjectCollection

GeocoderYaProxyV1ResponseData

GeocoderYaProxyV1Response

400 Bad Request

Body

Error

403 Forbidden

Body

500 Internal Server Error

Body