README

注意

请注意，MapTechnica API系统现在处于Beta测试阶段。如果您想参与Beta测试计划，可以在此注册

https://www.maptechnica.com/beta-signup

如果您希望在API正式发布时收到通知，请订阅此列表

http://eepurl.com/b0y8Mn

（我们保证不会向您发送垃圾邮件。）

概述

mtapi是一个composer包，让您可以从Laravel应用程序中轻松访问MapTechnica API。MapTechnica API（"MT API"）允许您检索以下地理类型的GIS边界、元数据和质心数据：

• 美国人口普查局数据
  • ZIP代码（ZCTA5s）
  • 三位数ZIP代码前缀（ZCTA3s）
  • 城市与地点
  • 县
  • 当前会期的国会选区
  • 学区
• 加拿大边界数据
  • FSAs（三位数邮政编码前缀）
  • 省

您可以在MapTechnica.com上查看这些数据的应用实例，并了解更多关于MapTechnica API的信息。

注意

本包的免费使用受MIT许可协议的保护。然而，要访问MT API，您需要获得一个许可证密钥，该密钥受其自身的使用限制和费用约束。有关更多信息，请访问MapTechnica.com的开发者部分。

获取MapTechnica API密钥（BETA）

API系统目前处于Beta测试阶段。如果您想参与Beta测试计划，请在此处填写请求表单

https://www.maptechnica.com/beta-signup

同时，您可以在此处注册一个账户

https://my.maptechnica.com/register

如果您被选中参与Beta测试计划，您将收到API密钥信息。

包安装

在终端中，从Laravel项目的根目录中安装包

composer require maptechnica\mtapi

Laravel 5.x

更新composer后，将ServiceProvider添加到config/app.php中的providers数组中

MapTechnica\MTAPI\MTAPIServiceProvider::class,

在config/app.php中添加别名

'MTAPI' => MapTechnica\MTAPI\MTAPIDataRetriever::class,

接下来，将配置文件移动到config目录。从您的项目根目录，输入

php artisan vendor:publish

现在您有选择。您可以直接修改config\mtapi.php文件中的值，如下所示

从

'apiKey'         => env('MAPTECHNICA_API_KEY', NULL),

到

'apiKey'         => env('MAPTECHNICA_API_KEY', '[YOUR_API_KEY]'),

或者，如果您所在的环境需要根据服务器位置使用不同的密钥，请保持config\mtapi.php不变，并在.env文件中添加以下变量

MAPTECHNICA_API_KEY=[YOUR_API_KEY]

安装后

一旦Composer完成操作，并且假设您的Laravel应用程序正在运行，打开...

http://yourapp/__mtapi

...在浏览器中。您应该看到一个链接页面。

检查您的安装

点击“检查安装”按钮，确保您的变量设置正确，并且API正在响应对您的请求。

学习API

点击“API文档”按钮，查看Swagger沙箱和API文档。

获取帮助

如果您遇到问题，有几种资源可供您使用

• 开发者论坛 - 在http://forum.maptechnica.com/向您的开发者同行寻求帮助并分享解决方案
• MapTechnica 支持 - 如果您发现了一个错误，或者遇到了论坛上没有解决的问题，您可以在 http://help.maptechnica.com/ 提交一个支持工单。请注意，调试您的应用程序不在API支持的范围内，所以请将您的问题限定为在API本身遇到的错误。

链接

项目主页： https://github.com/maptechnica/mtapi

Git 仓库： https://github.com/maptechnica/mtapi

API 文档（Swagger）： https://dev.maptechnica.com/apidocs/

MapTechnica API 使您能够直接将MapTechnica的边界数据集成到您的映射应用程序中。

此包旨在与Laravel 5+配合使用，或者作为您基于composer的项目中的独立包。