SDK engine

Google Scholar Case Law

Детали судебного дела Google Scholar по case_id: суд, даты, страницы, краткие цитирования, номера дел и процитированные дела.

engine: google_scholar_case_law TS: XylopSearchEngines.GoogleScholarCaseLaw JS: XylopSearchEngines.GoogleScholarCaseLaw C#: XylopSearchEngines.GoogleScholarCaseLaw Python: XylopSearchEngines.GOOGLE_SCHOLAR_CASE_LAW PHP: XylopSearchEngines::GOOGLE_SCHOLAR_CASE_LAW Ruby: XylopApiClient::Engines::GOOGLE_SCHOLAR_CASE_LAW Java: XylopSearchEngines.GOOGLE_SCHOLAR_CASE_LAW Kotlin: XylopSearchEngines.GOOGLE_SCHOLAR_CASE_LAW Swift: XylopSearchEngines.googleScholarCaseLaw Dart: XylopSearchEngines.googleScholarCaseLaw C++: xylop::api::engines::google_scholar_case_law Go: xylop.EngineGoogleScholarCaseLaw 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.GoogleScholarCaseLaw,
  {
    case_id: "case id from Google Scholar",
    no_cache: "false",
  });

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.GoogleScholarCaseLaw,
  {
    case_id: "case id from Google Scholar",
    no_cache: "false",
  });

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.GoogleScholarCaseLaw,
    new Dictionary<string, string?>
    {
        ["case_id"] = "case id from Google Scholar",
        ["no_cache"] = "false",
    });

Для типизированного режима используйте `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_SCHOLAR_CASE_LAW,
    {
        "case_id": "case id from Google Scholar",
        "no_cache": "false",
    },
)

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_SCHOLAR_CASE_LAW,
    [
        'case_id' => 'case id from Google Scholar',
        'no_cache' => 'false',
    ]
);

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_SCHOLAR_CASE_LAW,
  {
    "case_id" => "case id from Google Scholar",
    "no_cache" => "false",
  }
)

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_SCHOLAR_CASE_LAW,
    Map.of(
        "case_id", "case id from Google Scholar",
        "no_cache", "false"
    ));

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_SCHOLAR_CASE_LAW,
    mapOf(
        "case_id" to "case id from Google Scholar",
        "no_cache" to "false",
    ),
)

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.googleScholarCaseLaw,
    parameters: [
        "case_id": "case id from Google Scholar",
        "no_cache": "false",
    ]
)

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.googleScholarCaseLaw,
    <String, Object?>{
      'case_id': 'case id from Google Scholar',
      'no_cache': 'false',
    },
  );

  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_scholar_case_law,
        {
            {"case_id", "case id from Google Scholar"},
            {"no_cache", "false"},
        });

    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.EngineGoogleScholarCaseLaw,
        xylop.Params(map[string]string{
            "case_id": "case id from Google Scholar",
            "no_cache": "false",
        }),
        &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_scholar_case_law
API key
Передается SDK автоматически из настроек клиента.
Входные параметры

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

Параметр Тип Обязателен Значение Описание
api_key SDK string Да Ключ Xylop API. В SDK задается один раз в настройках или конструкторе клиента.
engine SDK string Да google_scholar_case_law Движок Google Scholar Case Law.
case_id string Да case id from Google Scholar Идентификатор дела из Google Scholar.
no_cache string Нет false Принудительно запросить свежий ответ.
Выходные параметры

Поля ответа

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

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

{
  "search_metadata": {
    "status": "Success",
    "google_scholar_case_law_url": "https://scholar.google.com/scholar_case?case=..."
  },
  "search_parameters": {
    "engine": "google_scholar_case_law",
    "case_id": "..."
  },
  "case_results": {
    "case_id": "...",
    "title": "Example v. Sample",
    "name": "Example v. Sample",
    "court_name": "Supreme Court of the United States",
    "first_page": 1,
    "last_page": 12,
    "dates": [
      {
        "position": 1,
        "type": "decided",
        "date": "Jun 1, 2020"
      }
    ],
    "short_citations": [
      {
        "position": 1,
        "name": "Example"
      }
    ],
    "case_numbers": [
      {
        "position": 1,
        "id": "No. 19-100",
        "link": "https://example.com/case",
        "docket_numbers": [
          {
            "position": 1,
            "docket_number": "19-100"
          }
        ]
      }
    ],
    "cited_cases": [
      {
        "position": 1,
        "case_id": "...",
        "case_link": "https://scholar.google.com/scholar_case?case=...",
        "citations": [
          {
            "case_name": "Earlier v. Case",
            "variations": [
              {
                "position": 1,
                "defendant": "Case",
                "citation": "123 U.S. 456"
              }
            ]
          }
        ]
      }
    ]
  }
}