建立连接

Owned by Aileen (Unlicensed)
Last updated: 2024-07-08 by tuhao
1 min read

建立连接需要两个参数: api_key和company_id, 缺一不可.

如无填写或者输入错误则会提示：Please login first

company_id：是指登陆的站点id（注意不是客户id）

正式环境-需登陆的站点id可咨询飞鸟客服。

测试环境-测试账号站点id：36

api_key：是指登陆的密钥。

正式环境-注册账号，可登陆后在设置—用户/个人信息中查询

测试环境-测试账号API密钥：42a005f656e1826f987a006e687889bf

以下是具体的查询的方法



  1. 与鸟系统对接首先要创建一个客户的API Key。

    用现有的客户账号登陆http://<系统域名>/client

     

      

    双击下面的条目或点击  图标即可编辑该条目打开检视窗口。

     

      
    如果没有API秘钥可以点击"生成新秘钥"生成一个新的。
    有了这个API Key以后，只要在REST请求里加一个名为api_key的Header就可以使用系统所有的资源了。


  2. 对接工具
    对接工具可以使用curl, httpclient库，和任意http工具。我们推荐使用postman工具来调试, (https://www.getpostman.com/downloads/), 可以更为直观的查看服务器返回的JSON记录
  3. 基本概念（1）company_id, 鸟系统是一个分站点管理的系统， 有华南站，英国站，法国站，德国站等站点，每个站点的账务和产品库存都是独立的，所以开始对接，我们要确定我们需要登录到哪个站点, 通过company_id来指定。完整的站点列表在第4节中会有描述。

  4. 获取company_id
     在浏览器地址栏直接输入 http://<系统域名>/client/public/company-list , 或者在通过postman客户端发送请求可以获取所有company


  5. 建立连接

    例如查询当前客户下所有用户：
    curl -H "api_key:42a005f656e1826f987a006e687889bf" -H "company_id: 1" http://<系统域名>/client/Client-User
    例如：

     


     

  6. 提交/POST
    提交的参数形式需要和Content-Type保持一致, 这里给出两种形式
    需要在header中定义下Content-Type的值, 
    表单形式 Content-Type:application/x-www-form-urlencoded,  
    Json形式 Content-Type:application/json