Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Xiaomi User API

The User API from Xiaomi — 4 operation(s) for user.

Xiaomi User API is one of 8 APIs that Xiaomi publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 4 paths, and defines 4 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against 3 base URLs: https://cnbj0.fds.api.xiaomi.com, https://awsbj0.fds.api.xiaomi.com, https://awssgp0.fds.api.xiaomi.com.

4 operations 4 paths 4 schemas 4 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://open.account.xiaomi.com
Authentication
HTTP Custom
Resource Areas
1

Authentication & Security 1

Xiaomi User API declares 1 security scheme for authenticating requests. It uses HTTP custom authentication (hmacAuth). By default, every request must be authenticated.

  • hmacAuth — HMAC-based signature authentication. Requests must include a Date header and Authorization header with HMAC-SHA1 signature.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 GET. Each is listed below with its method, path, parameters, and response codes.

User 4
GET
/user/profile
Get User Profile
getUserProfile 2 params → 200401403
GET
/user/openidV2
Get User OpenID
getUserOpenId 2 params → 200401
GET
/user/phoneAndEmail
Get User Phone and Email
getUserPhoneAndEmail 2 params → 200401
GET
/user/relation
Get User Friend List
getUserFriendList 2 params → 200401

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are UserContact (3 properties), UserProfile (3 properties), UserOpenId (3 properties), FriendList (3 properties). Each schema is shown below with its type and property counts.

FriendList
object
3 properties
UserOpenId
object
3 properties
UserProfile
object
3 properties
UserContact
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xiaomi-user-api-openapi.yml Raw ↑

Other APIs Xiaomi publishes across the network.

Xiaomi Access Control API
Xiaomi Authentication API
Xiaomi CDN API
Xiaomi Chat API
Xiaomi Models API
Xiaomi Multipart Upload API
Xiaomi Objects API