VertiName API 使用指南

3.1 解析寻址名 POST /resolve

功能：通过寻址名和 PIN 码获取详细地址和坐标信息。

请求参数

请求示例

curl -X POST "https://vertiname.com/api/v1/resolve" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
    "name": "jack@me",
    "code": "123456"
  }'

响应示例（成功）

{
  "success": true,
  "data": {
    "name": "jack@me",
    "lat": 40.7128,
    "lng": -74.0060,
    "address": "上海市浦东新区陆家嘴环路1088号",
    "phone": "13800138000",
    "real_name": "张三",
    "status": 1
  }
}

3.2 GPS 坐标查询 POST /gps

功能：批量查询寻址名的 GPS 坐标，支持距离计算和附近搜索。

mode: coordinates（查询坐标）

curl -X POST "https://vertiname.com/api/v1/gps" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
    "mode": "coordinates",
    "names": "jack@me,mary@me"
  }'

mode: distance（计算距离）

curl -X POST "https://vertiname.com/api/v1/gps" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
    "mode": "distance",
    "from": "jack@me",
    "to": "mary@me",
    "unit": "km"
  }'

mode: nearby（附近搜索）

curl -X POST "https://vertiname.com/api/v1/gps" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
    "mode": "nearby",
    "lat": 31.2304,
    "lng": 121.4737,
    "radius": 2000,
    "unit": "m"
  }'

3.3 注册寻址名 POST /register

功能：注册新的寻址名。

请求参数

6.1 cURL 示例

#!/bin/bash
API_KEY="YOUR_API_KEY"
API_URL="https://vertiname.com/api/v1/resolve"

VERTINAME="jack@me"
PIN_CODE="123456"

response=$(curl -s -X POST "$API_URL" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: $API_KEY" \
  -d "{\"name\":\"$VERTINAME\",\"code\":\"$PIN_CODE\"}")

echo "$response" | jq .

6.2 JavaScript 示例

async function resolveVertiName(vertiname, pin) {
    const response = await fetch('https://vertiname.com/api/v1/resolve', {
        method: 'POST',
        headers: {
            'Content-Type': 'application/json',
            'X-API-Key': 'YOUR_API_KEY'
        },
        body: JSON.stringify({
            name: vertiname,
            code: pin
        })
    });

    const data = await response.json();

    if (!data.success) {
        throw new Error(data.error);
    }

    return data.data;
}

// 使用示例
resolveVertiName('jack@me', '123456')
    .then(data => {
        console.log('姓名：', data.real_name);
        console.log('地址：', data.address);
        console.log('坐标：', data.lat, data.lng);
    })
    .catch(error => console.error('查询失败：', error));

6.3 PHP 示例

<?php
$apiKey = 'YOUR_API_KEY';
$url = 'https://vertiname.com/api/v1/resolve';

$data = [
    'name' => 'jack@me',
    'code' => '123456'
];

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Content-Type: application/json',
    'X-API-Key: ' . $apiKey
]);

$response = curl_exec($ch);
$result = json_decode($response, true);

if ($result['success']) {
    echo "姓名：" . $result['data']['real_name'] . "\n";
    echo "地址：" . $result['data']['address'] . "\n";
} else {
    echo "错误：" . $result['error'] . "\n";
}

curl_close($ch);
?>

6.4 Python 示例

import requests

API_KEY = 'YOUR_API_KEY'
URL = 'https://vertiname.com/api/v1/resolve'

def resolve_vertiname(vertiname, pin):
    headers = {
        'Content-Type': 'application/json',
        'X-API-Key': API_KEY
    }
    data = {
        'name': vertiname,
        'code': pin
    }

    response = requests.post(URL, headers=headers, json=data)
    result = response.json()

    if not result.get('success'):
        raise Exception(result.get('error'))

    return result.get('data')

# 使用示例
try:
    data = resolve_vertiname('jack@me', '123456')
    print(f"姓名：{data['real_name']}")
    print(f"地址：{data['address']}")
    print(f"坐标：{data['lat']}, {data['lng']}")
except Exception as e:
    print(f"错误：{e}")