SDKs

A API é HTTPS e JSON simples, então já funciona a partir de qualquer linguagem. Também estamos criando uma biblioteca oficial para cada uma das linguagens abaixo. Cada uma é propositalmente pequena: um cliente tipado para os oito endpoints, timeouts, novas tentativas em 429 e 503 e debounce para o preenchimento automático. Sem framework, sem plugins.

Status por linguagem

JavaScript e TypeScript Em desenvolvimento

npm install @mygeocode/sdk

Funciona no Node 18+, Deno, Bun e navegadores. Inclui tipos.

Python Em desenvolvimento

pip install mygeocode

Python 3.9+. Clientes síncrono e assíncrono, sem dependências além do httpx.

PHP Planejado

composer require mygeocode/sdk

PHP 8.1+. Cliente PSR-18, use a sua própria biblioteca HTTP.

Go Planejado

go get github.com/mygeocode/mygeocode-go

Apenas a biblioteca padrão. Compatível com context.

Java Planejado

com.mygeocode:sdk

Java 11+. Construído sobre java.net.http, também utilizável a partir de Kotlin.

C# Planejado

dotnet add package MyGeocode

.NET 6+. Assíncrono do início ao fim, System.Text.Json.

Ruby Planejado

gem install mygeocode

Ruby 3.0+. Net::HTTP, sem dependências em tempo de execução.

Rust Planejado

cargo add mygeocode

reqwest e serde, assíncrono por padrão.

Os comandos de instalação acima estão reservados e vão funcionar no dia em que cada biblioteca for lançada. Quer saber quando? Envie um e-mail em branco para support@mygeocode.com e responderemos uma única vez, quando houver algo para instalar.

O que todo SDK vai fazer

Um método por endpoint

client.forward("..."), client.reverse(lat, lon), client.ipv4("8.8.8.8") e assim por diante. Os valores de retorno são registros tipados que espelham o JSON exatamente, com os mesmos nomes de campos.

Novas tentativas que respeitam os cabeçalhos

Um 429 com horário de reinício é repetido depois desse horário, até um limite que você define. Um 503 é repetido com backoff. Todo o resto é lançado como erro, com o code e a message da API.

Tratamento da chave

Passe uma chave para o construtor ou defina MYGEOCODE_KEY no ambiente. Nada é gravado em disco. A falta de chave gera um erro imediato, com uma indicação do painel.

Use a API HTTP hoje

Aqui está uma geocodificação reversa com tratamento de erros e nova tentativa em 429, nas linguagens que os primeiros SDKs vão cobrir. É mais ou menos o que as bibliotecas vão fazer internamente.

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)
}

Usa o SDK de outro provedor?

Talvez você não precise do nosso. As bibliotecas cliente oficiais do Google Maps, Bing, HERE, Mapbox e ipinfo, em sua maioria, aceitam uma URL base personalizada, e os nossos hosts compatíveis respondem nos formatos desses provedores. Aponte a biblioteca para o host correspondente em www.mygeocode.com e mantenha o código que você já tem.