API描述

本API是幽灵鲨CRM系统对外提供的“应用程序接口”。开发者能够通过一系列接口与幽灵鲨CRM进行“交互”,基于API开发自己的应用程序、满足自身多样化需求。

开发步骤

1. 添加API请求账户

登录超级管理员账号,添加一个专门用于api请求的用户,并设置好用户名和密码,api请求用户也可以当普通用户登录使用系统

2. 设置API请求权限

可以创建一个角色用于单独设置api的权限,比如api只需要用户管理的权限,然后将该角色添加到api用户上

3. 调用用户登录获取请求token

参见 http://doc.youlingsha.com/docs/api/api-1fvovie3g3kqc 用户登录接口
通过该接口输入正确的用户名和密码后将返回token以及token的有效期,后续请求均需携带该token进行请求

4. 携带token请求API

在http的header中添加token,如下:

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ8.eyJpc3MiOiJodHRwczpcL1wvd2FuZy52OC55b3VsaW5nc2hhLmNvbVwvYXBpXC9hdXRoXC9sb2dpbiIsImlhdCI6MTcyOTIzMTAxMiwiZXhwIjoxNzI5NDQ3MDEyLCJuYmYiOjE3MjkyMzEwMTIsImp0aSI6IndyRG1aa0UwcVJ2d2tUWW4iLCJzdWIiOiIxIiwicHJ2IjoiMjNiZDVjODk0OWY2MDBhZGIzOWU3MDFjNDAwODcyZGI3YTU5NzZmNyIsInRlbmFudCI6IndhbmciLCJkb21haW4iOiJ3YW5nLnY4LnlvdWxpbmdzaGEuY29tIn0.Cize-ABW9KTGR80QaeeL0wSaWfFvUN5NUe-GyXC1tY1

所有POST请求类型的api,均使用json格式请求, header头需要设置

Content-Type: application/json

5. 其他注意事项

针对于客户管理和模块管理的API,需要添加一个特殊的default-product-id header,值为具体的产品线id,表示当前请求的是是哪个产品线的数据

default-product-id: 1
作者:admin  创建时间:2024-10-17 11:07
最后编辑:admin  更新时间:2024-10-19 12:15