SDK engine

Google Maps Directions

Google Maps route directions by address, data id or coordinates.

engine: google_maps_directions TS: XylopSearchEngines.GoogleMapsDirections JS: XylopSearchEngines.GoogleMapsDirections C#: XylopSearchEngines.GoogleMapsDirections Python: XylopSearchEngines.GOOGLE_MAPS_DIRECTIONS PHP: XylopSearchEngines::GOOGLE_MAPS_DIRECTIONS Ruby: XylopApiClient::Engines::GOOGLE_MAPS_DIRECTIONS Java: XylopSearchEngines.GOOGLE_MAPS_DIRECTIONS Kotlin: XylopSearchEngines.GOOGLE_MAPS_DIRECTIONS Swift: XylopSearchEngines.googleMapsDirections Dart: XylopSearchEngines.googleMapsDirections C++: xylop::api::engines::google_maps_directions Go: xylop.EngineGoogleMapsDirections GET /search

TypeScript пример

Вызов через @xylop/api-client-typescript

import { XylopSearchClient, XylopSearchEngines } from "@xylop/api-client-typescript";

interface SearchResponse {
  [key: string]: unknown;
}

const client = new XylopSearchClient({
  apiKey: "YOUR_API_KEY"
});

const response = await client.search<SearchResponse>(
  XylopSearchEngines.GoogleMapsDirections,
  {
    start_addr: "Austin, TX",
    end_addr: "San Antonio, TX",
    start_coords: "30.2672,-97.7431",
    end_coords: "29.4241,-98.4936",
    travel_mode: "0",
  });

TypeScript SDK написан на TypeScript, генерирует `.d.ts`, поддерживает generic response type и работает через `fetch`.

JavaScript пример

Вызов через @xylop/api-client

import { XylopSearchClient, XylopSearchEngines } from "@xylop/api-client";

const client = new XylopSearchClient({
  apiKey: "YOUR_API_KEY"
});

const response = await client.search(
  XylopSearchEngines.GoogleMapsDirections,
  {
    start_addr: "Austin, TX",
    end_addr: "San Antonio, TX",
    start_coords: "30.2672,-97.7431",
    end_coords: "29.4241,-98.4936",
    travel_mode: "0",
  });

JavaScript SDK работает в Node.js 18+ и современных браузерах через `fetch`; TypeScript declarations входят в npm package.

C# пример

Вызов через XylopSearchClient

using Xylop.Api.Client;

var client = new XylopSearchClient(new HttpClient(), "YOUR_API_KEY");

using var response = await client.SearchJsonAsync(
    XylopSearchEngines.GoogleMapsDirections,
    new Dictionary<string, string?>
    {
        ["start_addr"] = "Austin, TX",
        ["end_addr"] = "San Antonio, TX",
        ["start_coords"] = "30.2672,-97.7431",
        ["end_coords"] = "29.4241,-98.4936",
        ["travel_mode"] = "0",
    });

Для типизированного режима используйте `SearchAsync<TResponse>` и response-модель из `Xylop.Logic.SerpApiResponses.*`, которая входит в пакет C# SDK.

Python пример

Вызов через xylop-api-client

from xylop_api_client import XylopSearchClient, XylopSearchEngines

client = XylopSearchClient("YOUR_API_KEY")

response = client.search(
    XylopSearchEngines.GOOGLE_MAPS_DIRECTIONS,
    {
        "start_addr": "Austin, TX",
        "end_addr": "San Antonio, TX",
        "start_coords": "30.2672,-97.7431",
        "end_coords": "29.4241,-98.4936",
        "travel_mode": "0",
    },
)

Python SDK возвращает JSON как обычные `dict`/`list` и не требует runtime-зависимостей.

PHP пример

Вызов через xylop/api-client

<?php

use Xylop\Api\Client\XylopSearchClient;
use Xylop\Api\Client\XylopSearchEngines;

$client = new XylopSearchClient('YOUR_API_KEY');

$response = $client->search(
    XylopSearchEngines::GOOGLE_MAPS_DIRECTIONS,
    [
        'start_addr' => 'Austin, TX',
        'end_addr' => 'San Antonio, TX',
        'start_coords' => '30.2672,-97.7431',
        'end_coords' => '29.4241,-98.4936',
        'travel_mode' => '0',
    ]
);

PHP SDK использует стандартные stream wrappers, возвращает decoded JSON array и не требует runtime-зависимостей.

Ruby пример

Вызов через xylop-api-client

require "xylop_api_client"

client = XylopApiClient::Client.new(api_key: "YOUR_API_KEY")

response = client.search(
  XylopApiClient::Engines::GOOGLE_MAPS_DIRECTIONS,
  {
    "start_addr" => "Austin, TX",
    "end_addr" => "San Antonio, TX",
    "start_coords" => "30.2672,-97.7431",
    "end_coords" => "29.4241,-98.4936",
    "travel_mode" => "0",
  }
)

Ruby SDK использует стандартные `net/http`, `json` и возвращает JSON как обычные Hash/Array значения.

Java пример

Вызов через xylop-api-client

import java.util.Map;
import ru.xylop.api.client.XylopSearchClient;
import ru.xylop.api.client.XylopSearchEngines;

var client = new XylopSearchClient("YOUR_API_KEY");

String responseJson = client.searchJson(
    XylopSearchEngines.GOOGLE_MAPS_DIRECTIONS,
    Map.of(
        "start_addr", "Austin, TX",
        "end_addr", "San Antonio, TX",
        "start_coords", "30.2672,-97.7431",
        "end_coords", "29.4241,-98.4936",
        "travel_mode", "0"
    ));

Java SDK использует `java.net.http.HttpClient`, возвращает JSON-строку и не требует runtime-зависимостей.

Kotlin пример

Вызов через xylop-api-kotlin-client

import ru.xylop.api.kotlin.XylopSearchClient
import ru.xylop.api.kotlin.XylopSearchEngines

val client = XylopSearchClient("YOUR_API_KEY")

val responseJson = client.searchJson(
    XylopSearchEngines.GOOGLE_MAPS_DIRECTIONS,
    mapOf(
        "start_addr" to "Austin, TX",
        "end_addr" to "San Antonio, TX",
        "start_coords" to "30.2672,-97.7431",
        "end_coords" to "29.4241,-98.4936",
        "travel_mode" to "0",
    ),
)

Kotlin SDK использует JVM `HttpClient`, возвращает JSON-строку и оставляет JSON-маппинг приложению.

Swift пример

Вызов через XylopApiClient

import XylopApiClient

let client = XylopSearchClient(apiKey: "YOUR_API_KEY")

let response = try await client.searchJSON(
    engine: XylopSearchEngines.googleMapsDirections,
    parameters: [
        "start_addr": "Austin, TX",
        "end_addr": "San Antonio, TX",
        "start_coords": "30.2672,-97.7431",
        "end_coords": "29.4241,-98.4936",
        "travel_mode": "0",
    ]
)

Swift SDK использует Foundation `URLSession`, поддерживает async/await и возвращает Data, JSONSerialization values или caller-owned Decodable models.

Dart пример

Вызов через xylop_api_client

import 'package:xylop_api_client/xylop_api_client.dart';

Future<void> main() async {
  final client = XylopSearchClient('YOUR_API_KEY');

  final response = await client.search(
    XylopSearchEngines.googleMapsDirections,
    <String, Object?>{
      'start_addr': 'Austin, TX',
      'end_addr': 'San Antonio, TX',
      'start_coords': '30.2672,-97.7431',
      'end_coords': '29.4241,-98.4936',
      'travel_mode': '0',
    },
  );

  print(response);
}

Dart SDK использует `dart:io`, возвращает decoded JSON или raw response text и не требует runtime-зависимостей.

C++ пример

Вызов через Xylop.Api.Cpp

#include <xylop/api/client.hpp>
#include <xylop/api/curl_transport.hpp>

int main()
{
    xylop::api::search_client client(
        "YOUR_API_KEY",
        xylop::api::curl_transport);

    auto response_json = client.search_text(
        xylop::api::engines::google_maps_directions,
        {
            {"start_addr", "Austin, TX"},
            {"end_addr", "San Antonio, TX"},
            {"start_coords", "30.2672,-97.7431"},
            {"end_coords", "29.4241,-98.4936"},
            {"travel_mode", "0"},
        });

    return 0;
}

C++ SDK имеет header-only C++17 core, принимает transport callback и может использовать optional libcurl adapter `xylop::api::curl_transport`.

Go пример

Вызов через Xylop.Api.Go

package main

import (
    "context"
    "log"

    xylop "github.com/Leonid-Vizel/Xylop.AdminPanel/src/Xylop.Api.Go"
)

func main() {
    client, err := xylop.NewClient("YOUR_API_KEY")
    if err != nil {
        log.Fatal(err)
    }

    var response map[string]any
    err = client.SearchJSON(
        context.Background(),
        xylop.EngineGoogleMapsDirections,
        xylop.Params(map[string]string{
            "start_addr": "Austin, TX",
            "end_addr": "San Antonio, TX",
            "start_coords": "30.2672,-97.7431",
            "end_coords": "29.4241,-98.4936",
            "travel_mode": "0",
        }),
        &response)
    if err != nil {
        log.Fatal(err)
    }
}

Go SDK возвращает raw JSON bytes или декодирует ответ в пользовательскую структуру, `map[string]any` либо другой target.

Endpoint

HTTP контракт

URL: https://api.xylop.ru/search
Engine: google_maps_directions
API key: Передается SDK автоматически из настроек клиента.

Входные параметры

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

Параметр	Тип	Обязателен	Значение	Описание
`api_key` SDK	string	Да	—	Ключ Xylop API. В SDK задается один раз в настройках или конструкторе клиента.
`engine` SDK	string	Да	`google_maps_directions`	Google Maps Directions engine.
`start_addr`	string	Нет	Austin, TX	Start address.
`end_addr`	string	Нет	San Antonio, TX	End address.
`start_coords`	string	Нет	30.2672,-97.7431	Start coordinates.
`end_coords`	string	Нет	29.4241,-98.4936	End coordinates.
`travel_mode`	number	Нет	0	Travel mode code.

Выходные параметры

Поля ответа

Поле	Тип	Источник	Описание
`search_metadata`	object	пример ответа	Метаданные запроса: статус, идентификатор, время выполнения и служебная информация провайдера.
`directions`	array	пример ответа	Типизированное поле ответа для этого engine; структура зависит от upstream-провайдера и параметров запроса.

JSON

Пример ответа

{
  "search_metadata": {
    "status": "Success",
    "google_maps_directions_url": "https://www.google.com/maps/dir/..."
  },
  "directions": [
    {
      "title": "Fastest route",
      "distance": "80 mi",
      "duration": "1 hr 20 min"
    }
  ]
}