README

此包提供了一个轻量级的SDK，用于与MapIt API交互。它不包含所有方法，只包含我们作为组织经常使用的方法。

安装

您可以通过Composer安装此包

composer require c6digital/mapit-php

使用

use C6Digital\MapIt\MapIt;

$mapIt = new MapIt(
    key: 'your-mapit-key-here',          // Your MapIt API key / token.
    url: 'https://mapit.mysociety.org'  // An optional MapIt URL.
);

Laravel

如果您使用Laravel，此包提供了一个服务提供程序，它将自动注册MapIt类并使用.env变量来配置密钥和URL。

MAPIT_KEY=...
MAPIT_URL=...

您可以在需要使用它时从容器中请求它。

use C6Digital\MapIt\MapIt;

class MyController
{
    public function __invoke(MapIt $mapIt)
    {
        // ...
    }
}

检索邮编

$mapIt->postcode('SW1P 3BD');

当发生错误时抛出

$mapIt->throw()->postcode(...);

测试

composer test

变更日志

请参阅CHANGELOG获取有关最近更改的更多信息。

贡献

请参阅CONTRIBUTING获取详细信息。

安全漏洞

请审查我们的安全策略了解如何报告安全漏洞。

致谢

许可

MIT许可（MIT）。请参阅许可文件获取更多信息。

c6digital / mapit-php

维护者

详细信息