我需要一个 API。我应该从哪里开始？

Question

我正在从头开始构建 PHP 应用程序（使用 Kohana3 框架）。我将对其进行架构设计，以便可以使用 API 在内部访问数据。同时，我想最终将其提供给公众。

我计划使用 RESTful 访问方法。但是，我很难找到有关如何正确保护 API 的明确信息。也就是说，如何实现API签名和访问呢？

Answer 1

您可以尝试 frapi。它将快速允许您构建 RESTful API，然后您可以将其用于您的应用程序，并在稍后公开公开相同的 API。

Answer 2

OAuth 将是一个不错的选择。单个键/值对也是如此。您可能还想查看 Mashape 但不完全确定它适合您想要做的事情。

Answer 3

我认为一个好的起点是阅读有关数字签名的一般信息。维基百科是一个很棒的资源 http://en.wikipedia.org/wiki/Public_Key_Infrastruct 或 http://en.wikipedia.org/wiki/X.509。
在基本层面上，我会给每个客户一个私钥。在客户端库中，我将加密密钥。当客户端发出请求时，请验证密钥是否是您颁发给该特定客户端的密钥。

Answer 4

看一下 3scale (http://www.3scale.net/) 来执行此操作 - 它处理身份验证、访问控制、策略、速率限制等，并且对于大量流量免费。我们有一个 PHP 模块可以插入到系统中以启用这些功能。 （免责声明 - 我在那里工作 - 但希望它有用！）

Answer 5

你的问题比这个大一点；但我可以提供一个关于 REST 的小观察。

我在 REST 中发现，底层数据模型最好使用人工键，而不是自然键。

例如，考虑 RESTfull url：https://server/yourApp/viewUser/1234.html 这将显示 ID 为 1234 的用户。但是，如果您使用自然键，您可能会拥有类似以下的 URL这个 https://server/yourApp/viewUser/Bob.html 或更糟的是，如果不是 Bob，而是“Bob X”或“Bob?key=Value”。您不想必须考虑生成无效的 URL。

Answer 6

我使用 CodeIgniter 和基本身份验证制作了 PHP REST API（提供“公司 ID”和“API 密钥”作为用户名/密码）。后来我们发现有必要提供与 API Key 直接相关的会话密钥，仅具有过期时间。

基本上，我们根据 URL 中提供的“方法”查询数据存储中不同类型的数据（nosql 品种:)。我们通过使用 CodeIgniter 提供的“段”功能来访问它。

然后我们用返回的“json_encode”包装每个响应，并且我们还使用 HTTPS 连接来确保安全。

对于客户端类，我们将所有内容包装在 $client->get_my_data($api_key) 等调用中，并在下面使用 PHP Libcurl 一层，它可以很好地提供基本身份验证。

希望这有帮助，

CURL_GET

    private function curl_get($url, $apikey, $co)
    {
        $curl_handle = curl_init();
        curl_setopt($curl_handle, CURLOPT_URL, $url);
        curl_setopt($curl_handle, CURLOPT_CONNECTTIMEOUT, 2);
        curl_setopt($curl_handle, CURLOPT_SSL_VERIFYPEER, FALSE);
        curl_setopt($curl_handle, CURLOPT_USERPWD, $co.":".$apikey);
        curl_setopt($curl_handle, CURLOPT_RETURNTRANSFER, 1);
        curl_setopt($curl_handle, CURLOPT_DNS_USE_GLOBAL_CACHE, FALSE);

        $buffer = curl_exec($curl_handle);
        $error = curl_error($curl_handle);
        curl_close($curl_handle);
        // check for success or failure
        if (empty($buffer)) {
        //echo 'Something went wrong :( error: '.$error.'<Br>';
        } else {
        return $buffer;
        }
    }