SDK
API 就是普通的 HTTPS 和 JSON,因此已经可以在任何语言中使用。我们还在为下列每种语言构建官方库。每个库都刻意保持精简:针对八个端点的类型化客户端、超时、遇到 429 和 503 时重试,以及自动补全防抖。没有框架,没有插件。
各语言进度
JavaScript 和 TypeScript 开发中
npm install @mygeocode/sdk支持 Node 18+、Deno、Bun 和浏览器。自带类型定义。
Python 开发中
pip install mygeocodePython 3.9+。同步和异步客户端,除 httpx 外没有其他依赖。
PHP 计划中
composer require mygeocode/sdkPHP 8.1+。PSR-18 客户端,可使用您自己的 HTTP 库。
Go 计划中
go get github.com/mygeocode/mygeocode-go仅使用标准库。支持 context。
Java 计划中
com.mygeocode:sdkJava 11+。基于 java.net.http 构建,也可在 Kotlin 中使用。
C# 计划中
dotnet add package MyGeocode.NET 6+。全面异步,使用 System.Text.Json。
Ruby 计划中
gem install mygeocodeRuby 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 会使用退避策略重试。其他所有情况都会作为错误抛出,并附带 API 的 code 和 message。
密钥处理
将密钥传给构造函数,或在环境变量中设置 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?
您可能不需要我们的 SDK。Google Maps、Bing、HERE、Mapbox 和 ipinfo 的官方客户端库大多支持自定义基础 URL,而我们的兼容替换主机会以这些服务商的格式作答。将库指向对应的 www.mygeocode.com 主机,保留您现有的代码即可。