2gis-api 中文文档教程

Question

2GIS API for Node.js

About module

该模块实现了对 NodeJS 的 API 2GIS 调用。 目前，以下部分 API：

• Catalog API
• Geo data API

Installation

npm install 2gis-api

Usage

    var api = require ('2gis-api');

    api.configure({
        serviceUrl: 'catalog.api.2gis.ru', // This is optional default path.
        version: 1.3, // This is optional default version.

        key: 'YOUR_API_KEY' // Required. Get it from the vendor.
    });

    api.projectList({}, function (err, data) {
        console.log('projectList', err, data);
    });

    api.rubricator({
        where: 'Красноярск',
        show_children: 1
    }, function (err, data) {
        console.log('rubricator', err, data);
    });

重要！ 要获取填写申请表所需的 API 密钥。

Catalog API

"projectList"

该方法返回一个项目列表（一个大城市和周围的村庄）。 传入和传出参数的值在 API 方法文档 中列出。

"rubricator"

选择此评分细则为其父级的评分细则。 API 方法文档。

"search"

从给定的查询中搜索公司并显示分页的找到的结果列表。 API 方法文档。

"firms"

search 的别名。

"searchInRubric"

在此类别中搜索给定的查询公司并给出分页的匹配列表。 API 方法文档。

"firmsByFilialId"

通过唯一标识符返回公司办公室列表。 API 方法文档。

"adsSearch"

在给定查询中搜索广告商。 API 方法文档。

"ads"

adsSearch 的别名。

"profile"

通过其唯一标识符返回有关分支机构配置文件的详细信息。 API 方法文档。

"firmProfile"

配置文件 的别名。

Geo data API

"geoSearch"

选择符合搜索条件的地理对象。 API 方法文档。

"geoGet"

通过其标识符返回有关地理对象的信息。 API 方法文档。

Features of the implementation under Node.js

• query parameters with commas in the original API can be represented as an array:

    ...
    api.firms({
        what: 'установка окон',

        filters: {
            worktime: ['sat', '15:00'] // <- This is it.
        }

    }, function (err, data) {
        console.log('firms', err, data);
    });
    ...

• complex structure of the form bound [point1] = 37.432,55.836 & bound [point2] = 37.633,55.637 can be represented as an object:

    ...
    api.firms({
        what: 'установка окон',

        bound: {
                point1: '37.432,55.836', // <- This is it...
                point2: [37.633, 55.637] // <- Or an array.
            }

    }, function (err, data) {
        console.log('firms', err, data);
    });
    ...

Issues

有错误吗？ 请在 GitHub 上创建问题！

https://github.com/Staltec/2gis-api/issues

License

（麻省理工学院许可证）

版权所有 (c) 2013 Alexander Prozorov (staltec@gmail.com)

特此免费授予任何获得本软件和相关文档文件（“软件”），不受限制地处理本软件，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或出售本软件副本的权利，并允许获得软件的人这样做，但须满足以下条件：

上述版权声明和本许可声明应包含在软件的所有副本或重要部分中。

本软件“按原样”提供，不提供任何明示或暗示的保证，包括但不限于对适销性、特定用途的适用性和非侵权性的保证。 在任何情况下，作者或版权持有人均不对任何索赔、损害或其他责任负责，无论是在合同诉讼、侵权行为还是其他方面，由软件或软件的使用或其他交易引起、由软件引起或与之相关软件。