# 注册与创建应用

# 1.注册与登录

1. 打开船讯网，进入API首页

![image (1).png](https://api.apifox.com/api/v1/projects/8040680/resources/668403/image-preview)
* 点击注册进入注册页面，如果已经有船讯网账号，可以直接点击登录船讯网账号。登录了船讯网账号，可以直接创建应用。

![image (2).png](https://api.apifox.com/api/v1/projects/8040680/resources/668404/image-preview)
* 注册账号：您可以通过访问船讯网首页或直接进入船讯网API控制台进行注册。

![image (3).png](https://api.apifox.com/api/v1/projects/8040680/resources/668405/image-preview)
* 登录：注册完成后，使用您的账号和密码登录API控制台。

![image (4).png](https://api.apifox.com/api/v1/projects/8040680/resources/668406/image-preview)

* 注意：需要注意船讯网客户中已经接入过旧版本api的，还是需要去老用户目前已经接入api的入口。

![image (5).png](https://api.apifox.com/api/v1/projects/8040680/resources/668407/image-preview)

# 2.创建应用Key

1. 进入应用管理模块：登录后，进入API新版本控制台中的“应用管理”模块。

![image (6).png](https://api.apifox.com/api/v1/projects/8040680/resources/668409/image-preview)

* 创建应用Key：点击“创建应用”，填写相关信息后生成应用Key。选择创建试用的key可以具备一定的初始权限，辅助做一些功能性的测试。  如果您要正式使用我们船讯网的服务，开通更多的服务权限，请创建正式的key并联系商务。 已经开通正式key的也可以再创建试用key，一个账户最多有一个试用的key。

![image (7).png](https://api.apifox.com/api/v1/projects/8040680/resources/668411/image-preview)

* 创建完的key，点击复制按钮，可以直接将key复制出来，如果是测试账号可以直接使用key调用基础服务，如果需要额外开通权限，把key发给您对接的销售人员即可。

![image (8).png](https://api.apifox.com/api/v1/projects/8040680/resources/668412/image-preview)

## 权限说明：

1. 一个账户最多可以注册5个应用Key。

* 第一个注册的应用Key具备初始测试权限，可用于基本功能测试。

* 其他应用Key需要联系商务团队开通权限。

# 3.发送请求与接收数据

1. 拼接HTTP请求URL：根据API文档，拼接HTTP请求URL，并将申请的Key作为必填参数一同发送。

* 接收数据：发送请求后，接收HTTP请求返回的数据，数据格式为JSON或二进制。

* 解析数据：解析返回的数据，根据业务需求进行处理。

# 4.推送类服务的使用

1. 创建监控船队：在控制台中创建需要监控的船队，并关联对应的推送权限。

![image (9).png](https://api.apifox.com/api/v1/projects/8040680/resources/668413/image-preview)

![image (10).png](https://api.apifox.com/api/v1/projects/8040680/resources/668414/image-preview)

* 绑定接收URL：提前绑定您接收推送消息的URL，确保能够接收实时推送数据。

![image (11).png](https://api.apifox.com/api/v1/projects/8040680/resources/668415/image-preview)

* 设置推送服务：区域提醒推送服务需要配置参数，如监控全部船舶、按分类筛选或自有船队进出提醒等。

![image (12).png](https://api.apifox.com/api/v1/projects/8040680/resources/668416/image-preview)

![image (13).png](https://api.apifox.com/api/v1/projects/8040680/resources/668417/image-preview)

# 5.注意事项

1. 数据格式：确保请求的数据格式符合API文档的要求，避免因格式问题导致请求失败或数据解析错误。

* 权限管理：合理管理应用Key的权限，避免权限滥用或不足影响业务运行。

# 6.联系我们

1. 开通权限：如果需要为其他应用Key开通权限，或需要更多高级功能，请联系商务团队。

* 联系方式：

* 邮箱：support@shipxy.com

* 电话：400-010-8558 

* 技术支持：如在使用过程中遇到问题，可联系船讯网技术支持团队获取帮助。

* 邮箱：service@shipxy.com