ERP对接API接口顺序

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

1、注册账号

1、可以通过 https://<系统域名>/site/index/register 主动注册一个测试账号

2、也可以通过销售经理主动开设账号

3、注册账号后，会提供对应的 用户名/密码

2、获取 api_key（通用）

1、登录到系统
2、登录页面后，点击菜单栏 ”设置“ 下的 “个人信息”
3、打开后找到“API秘钥”字样，复制对应的值，用于后续接口对接登录凭证

如下图:

3、获取 company_id（通用）

  1. 登录到系统

  2. 登录页面后，点击菜单栏右上角的站点名称

  3. 打开“进入其他站点”对话框，下拉框中显示的是当前用户有权限登录的站点, 站点名称的前两位/三位数字即company_id

如下图:

4、接口基本操作（通用）

系统API采用 restful风格，通过url的GET, POST, PUT, DELETE可以直接操作相应的对象.

基本使用参考:

https://birdsystem.atlassian.net/wiki/spaces/DEV/pages/1540385

https://birdsystem.atlassian.net/wiki/spaces/DEV/pages/1540390

5、对接具体业务接口

完整接口见 https://birdsystem.atlassian.net/wiki/spaces/DEV/pages/1944748045 。 以下是较常用业务接口:

站点信息

https://birdsystem.atlassian.net/wiki/spaces/DEV/pages/1953726708

辅助数据, 用于获取客人开通的全部站点信息。调用其他业务接口需要传company_id, 此接口可以获取到完整的可用的company_id.

邮递服务信息

https://birdsystem.atlassian.net/wiki/spaces/DEV/pages/1953628356

用于获取发货渠道信息。下出库单需要提供出货渠道delivery_service_id, 此接口可以获取到完整的可用的delivery_service_id列表

产品信息

https://birdsystem.atlassian.net/wiki/spaces/DEV/pages/1953595810

https://birdsystem.atlassian.net/wiki/spaces/DEV/pages/1953595858

https://birdsystem.atlassian.net/wiki/spaces/DEV/pages/1953628642

https://birdsystem.atlassian.net/wiki/spaces/DEV/pages/1936556324

https://birdsystem.atlassian.net/wiki/spaces/DEV/pages/1942683734

用于创建和管理备案产品，以及产品库存。创建入库单(本地发货)和出库单都需要在鸟系统做产品信息备案，对接此接口方便批量备案产品.

入库单

https://birdsystem.atlassian.net/wiki/spaces/DEV/pages/2210070696

用于创建入库单，将产品入库到鸟系统

出库单

https://birdsystem.atlassian.net/wiki/spaces/DEV/pages/2609479794

https://birdsystem.atlassian.net/wiki/spaces/DEV/pages/2608922765

https://birdsystem.atlassian.net/wiki/spaces/DEV/pages/2221211778

https://birdsystem.atlassian.net/wiki/spaces/DEV/pages/1953628437

https://birdsystem.atlassian.net/wiki/spaces/DEV/pages/1953726822

https://birdsystem.atlassian.net/wiki/spaces/DEV/pages/1942290540

用于创建出库单，将产品通过发货渠道发到买家手里

6、生产环境和测试环境