iHRM人力资源管理系统-API文档-w.pdf

根据提供的文件信息，我们可以详细阐述iHRM人力资源管理系统的API文档知识点。本系统提供的API涵盖了城市列表、用户登录、用户资料信息获取以及组织架构信息的查询等功能。 城市列表接口（/api/sys/city）允许客户端通过GET方法请求获得城市基本信息。城市信息包含城市ID、城市名称等字段。此接口的响应状态码为200表示请求成功。如果系统繁忙时，会返回错误码99999。正常操作成功的错误码是10000。 用户登录接口（/api/sys/login）是一个POST方法的接口，通过此接口，用户可以登录系统。客户端请求时需要在Headers中指定Content-Type为application/json，Body中包含用户提交的手机号和密码。登录成功后，系统会返回一个包含token的响应数据，而登录失败则会返回错误码20001（用户名或密码错误）或99999（系统繁忙）。操作成功的标识是错误码10000。 用户资料基本信息接口（/api/sys/profile）通过POST方法可以获取登录用户的详细资料。客户端在Headers中需提供有效的token。成功响应时状态码为200，并返回用户的相关资料，如用户ID、手机号、用户名、公司名称、角色及权限等信息。错误码同样包括操作成功标识的10000，以及繁忙状态的99999。 组织架构列表接口（/api/company/department）可以查询公司部门结构，使用GET方法。客户端请求时需要在Headers中提供token。响应数据包括公司ID、公司名称、部门列表等信息。每个部门信息详细包括部门ID、父级ID、部门名称、部门代码、管理者的ID和姓名、部门介绍以及创建时间等。如果系统繁忙或请求失败，同样会返回99999或10000错误码。 以上各接口使用的HTTP状态码和错误码是API设计中的重要部分。状态码200表示请求成功，而错误码10000表示操作成功，这在常规设计中较为少见，通常操作成功的标识应该为200或201。错误码99999用来指示系统繁忙，需要客户端稍后重试，这是系统对请求做出的临时拒绝响应。 在使用这些接口时，客户端开发者需要注意API的调用限制，包括必填参数、请求和响应的格式，以及权限要求。比如，登录接口需要客户端提供正确的手机号和密码，而其他接口则需要提供有效的token以验证用户身份。 总体上，iHRM人力资源管理系统提供了一套完整的API服务，支持人力资源管理的各个环节，包括城市信息管理、用户登录与资料查询、组织架构信息查询等，通过这些接口可以方便地集成到企业级应用中，实现人员信息管理的自动化和智能化。开发者在开发过程中应当严格遵守API的使用规则，确保数据的正确性和安全性。