SDK

API построен на обычных HTTPS и JSON, поэтому уже работает из любого языка. Мы также создаём официальную библиотеку для каждого из языков ниже. Каждая намеренно небольшая: типизированный клиент для восьми эндпоинтов, тайм-ауты, повторы при 429 и 503 и debounce для автодополнения. Без фреймворка, без плагинов.

Статус по языкам

JavaScript и TypeScript В разработке

npm install @mygeocode/sdk

Работает в Node 18+, Deno, Bun и браузерах. Поставляется с типами.

Python В разработке

pip install mygeocode

Python 3.9+. Синхронный и асинхронный клиенты, без зависимостей, кроме httpx.

PHP Запланировано

composer require mygeocode/sdk

PHP 8.1+. Клиент PSR-18, HTTP-библиотеку выбираете вы.

Go Запланировано

go get github.com/mygeocode/mygeocode-go

Только стандартная библиотека. Поддержка context.

Java Запланировано

com.mygeocode:sdk

Java 11+. Построена на java.net.http, можно использовать и из Kotlin.

C# Запланировано

dotnet add package MyGeocode

.NET 6+. Полностью асинхронная, System.Text.Json.

Ruby Запланировано

gem install mygeocode

Ruby 3.0+. Net::HTTP, без зависимостей времени выполнения.

Rust Запланировано

cargo add mygeocode

reqwest и serde, асинхронная по умолчанию.

Команды установки выше зарезервированы и заработают в день выхода каждой библиотеки. Хотите узнать, когда? Отправьте пустое письмо на support@mygeocode.com, и мы ответим один раз, когда будет что устанавливать.

Что будет уметь каждый SDK

Один метод на эндпоинт

client.forward("..."), client.reverse(lat, lon), client.ipv4("8.8.8.8") и так далее. Возвращаемые значения представляют собой типизированные записи, которые в точности повторяют JSON, с теми же именами полей.

Повторы с учётом заголовков

Ответ 429 со временем сброса повторяется после этого времени, до заданного вами предела. Ответ 503 повторяется с увеличивающейся задержкой. Всё остальное выбрасывается как ошибка с code и message от API.

Работа с ключом

Передайте ключ в конструктор или задайте MYGEOCODE_KEY в переменных окружения. На диск ничего не записывается. При отсутствии ключа сразу выбрасывается ошибка со ссылкой на личный кабинет.

Используйте HTTP API уже сегодня

Вот обратное геокодирование с обработкой ошибок и повтором при 429 на тех языках, которые охватят первые SDK. Примерно это библиотеки и будут делать внутри.

const BASE = "https://api.mygeocode.com/v1";

async function reverse(lat, lon, { key = process.env.MYGEOCODE_KEY, retries = 2 } = {}) {
  const url = new URL(BASE + "/reverse");
  url.searchParams.set("lat", lat);
  url.searchParams.set("lon", lon);

  const headers = key ? { "X-API-Key": key } : {};
  const res = await fetch(url, { headers });

  if (res.status === 429 && retries > 0) {
    const reset = Number(res.headers.get("X-Quota-Reset")) * 1000;
    const wait = Math.min(Math.max(reset - Date.now(), 1000), 60_000);
    await new Promise((r) => setTimeout(r, wait));
    return reverse(lat, lon, { key, retries: retries - 1 });
  }

  const data = await res.json();
  if (data.status !== "ok") throw new Error(`${data.error.code}: ${data.error.message}`);
  return data.result;
}

const place = await reverse(48.8584, 2.2945);
console.log(place.formatted, place.precision);
import os
import time
import requests

BASE = "https://api.mygeocode.com/v1"


class MyGeocodeError(Exception):
    pass


def reverse(lat, lon, key=os.environ.get("MYGEOCODE_KEY"), retries=2):
    headers = {"X-API-Key": key} if key else {}
    r = requests.get(f"{BASE}/reverse", params={"lat": lat, "lon": lon}, headers=headers, timeout=10)

    if r.status_code == 429 and retries > 0:
        reset = int(r.headers.get("X-Quota-Reset", 0))
        time.sleep(min(max(reset - time.time(), 1), 60))
        return reverse(lat, lon, key=key, retries=retries - 1)

    data = r.json()
    if data["status"] != "ok":
        raise MyGeocodeError(f'{data["error"]["code"]}: {data["error"]["message"]}')
    return data["result"]


place = reverse(48.8584, 2.2945)
print(place["formatted"], place["precision"])
<?php
const BASE = "https://api.mygeocode.com/v1";

function reverse(float $lat, float $lon, ?string $key = null, int $retries = 2): array
{
    $key ??= getenv("MYGEOCODE_KEY") ?: null;
    $ch = curl_init(BASE . "/reverse?" . http_build_query(["lat" => $lat, "lon" => $lon]));
    curl_setopt_array($ch, [
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_TIMEOUT => 10,
        CURLOPT_HTTPHEADER => $key ? ["X-API-Key: $key"] : [],
    ]);
    $body = curl_exec($ch);
    $status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
    curl_close($ch);

    if ($status === 429 && $retries > 0) {
        sleep(5);
        return reverse($lat, $lon, $key, $retries - 1);
    }

    $data = json_decode($body, true);
    if ($data["status"] !== "ok") {
        throw new RuntimeException($data["error"]["code"] . ": " . $data["error"]["message"]);
    }
    return $data["result"];
}

$place = reverse(48.8584, 2.2945);
echo $place["formatted"], " (", $place["precision"], ")\n";
package main

import (
	"encoding/json"
	"errors"
	"fmt"
	"net/http"
	"net/url"
	"os"
	"strconv"
	"time"
)

const base = "https://api.mygeocode.com/v1"

type Result struct {
	Formatted string  `json:"formatted"`
	Lat       float64 `json:"lat"`
	Lon       float64 `json:"lon"`
	Precision string  `json:"precision"`
}

type envelope struct {
	Status string  `json:"status"`
	Result *Result `json:"result"`
	Error  *struct {
		Code    string `json:"code"`
		Message string `json:"message"`
	} `json:"error"`
}

func reverse(lat, lon float64, retries int) (*Result, error) {
	q := url.Values{"lat": {strconv.FormatFloat(lat, 'f', -1, 64)}, "lon": {strconv.FormatFloat(lon, 'f', -1, 64)}}
	req, _ := http.NewRequest("GET", base+"/reverse?"+q.Encode(), nil)
	if key := os.Getenv("MYGEOCODE_KEY"); key != "" {
		req.Header.Set("X-API-Key", key)
	}
	resp, err := (&http.Client{Timeout: 10 * time.Second}).Do(req)
	if err != nil {
		return nil, err
	}
	defer resp.Body.Close()

	if resp.StatusCode == 429 && retries > 0 {
		time.Sleep(5 * time.Second)
		return reverse(lat, lon, retries-1)
	}

	var env envelope
	if err := json.NewDecoder(resp.Body).Decode(&env); err != nil {
		return nil, err
	}
	if env.Status != "ok" {
		return nil, errors.New(env.Error.Code + ": " + env.Error.Message)
	}
	return env.Result, nil
}

func main() {
	place, err := reverse(48.8584, 2.2945, 2)
	if err != nil {
		panic(err)
	}
	fmt.Println(place.Formatted, place.Precision)
}

Используете SDK другого провайдера?

Возможно, наш вам не нужен. Официальные клиентские библиотеки Google Maps, Bing, HERE, Mapbox и ipinfo в большинстве случаев принимают собственный базовый URL, а наши совместимые хосты отвечают в форматах этих провайдеров. Направьте библиотеку на соответствующий хост www.mygeocode.com и оставьте свой код как есть.