JD.com Zeus Developer Platform

https://jos.jd.com
Admin
JD.com Zeus is an open API platform that provides retail partners and developers access to JD.com's...
Tokens:3,238
Snippets:77
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### API Integration Overview

Source: https://jos.jd.com/apilistnewdetail.html?first=335&second=336

General guidelines for accessing JD Zeus API services.

```APIDOC
## API Integration Overview

### Description
This section outlines the core components required to interact with the JD Zeus platform, including authorization, SDK usage, and error handling.

### Available API Categories
- **User API**: Manage user-related data.
- **Product API**: Manage product information and catalog data.
- **Dongdong API**: Messaging and communication services.

### Getting Started
1. **Permission Application**: Request access to specific API scopes.
2. **Authorization**: Obtain necessary access tokens via the authorization flow.
3. **SDK Usage**: Utilize provided SDKs for simplified integration.

### Error Handling
- Refer to the **Gateway Error Codes** documentation for troubleshooting API response issues.
```

--------------------------------

### API Call and SDK Usage

Source: https://jos.jd.com/apilistnewdetail.html?first=440&second=442

Information on how to make API calls and integrate the SDK.

```APIDOC
## API Call and SDK Usage

### Description
Guides on how to authenticate, make requests to the APIs, and use the provided SDKs for easier integration.

### Authentication
API requests require authentication. Please refer to the [Authentication Guide](link-to-auth-guide) for details on obtaining API keys and tokens.

### SDK Integration
Instructions for integrating the SDK into your project. Download the SDK from [here](link-to-sdk-download).

#### Example (JavaScript SDK)
```javascript
// Initialize SDK
const client = new JDClient({ apiKey: 'YOUR_API_KEY' });

// Make a user API call
client.users.get({ userId: '123e4567-e89b-12d3-a456-426614174000' })
  .then(user => console.log(user))
  .catch(error => console.error(error));
```
```

--------------------------------

### Product API

Source: https://jos.jd.com/apilistnewdetail.html?first=440&second=442

APIs for retrieving and managing product information.

```APIDOC
## Product API

### Description
APIs for fetching product details, categories, and inventory.

### Method
GET

### Endpoint
/api/products

### Parameters
#### Query Parameters
- **productId** (string) - Optional - The ID of the product to retrieve.
- **category** (string) - Optional - The category of products to filter by.

### Response
#### Success Response (200)
- **productId** (string) - The unique identifier for the product.
- **name** (string) - The name of the product.
- **price** (number) - The price of the product.
- **category** (string) - The category the product belongs to.

#### Response Example
```json
{
  "productId": "prod-abc-123",
  "name": "Example Product",
  "price": 99.99,
  "category": "Electronics"
}
```
```

--------------------------------

### JD Zeus API Overview

Source: https://jos.jd.com/apilistnewdetail.html?first=502&second=505

General information regarding the available API categories and developer resources on the JD Zeus platform.

```APIDOC
## JD Zeus API Overview

### Description
Provides access to various JD platform services including User, Product, and Dongdong (messaging) APIs.

### Available API Categories
- User API
- Product API
- Dongdong API

### Developer Resources
- Permission Application
- API Invocation Guide
- SDK Usage
- Gateway Error Codes
- Authorization Acquisition
```

--------------------------------

### User API

Source: https://jos.jd.com/apilistnewdetail.html?first=440&second=442

APIs related to user management and authentication.

```APIDOC
## User API

### Description
APIs for managing user accounts, profiles, and authentication.

### Method
GET, POST, PUT, DELETE

### Endpoint
/api/users

### Parameters
#### Query Parameters
- **userId** (string) - Optional - The ID of the user to retrieve.

#### Request Body
- **username** (string) - Required - The username for creating or updating a user.
- **email** (string) - Required - The email address of the user.

### Response
#### Success Response (200)
- **userId** (string) - The unique identifier for the user.
- **username** (string) - The user's username.
- **email** (string) - The user's email address.

#### Response Example
```json
{
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "username": "johndoe",
  "email": "john.doe@example.com"
}
```
```

--------------------------------

### Dongdong API

Source: https://jos.jd.com/apilistnewdetail.html?first=440&second=442

APIs for real-time communication features.

```APIDOC
## Dongdong API

### Description
APIs for sending and receiving messages, managing chat rooms, and user presence.

### Method
POST, GET

### Endpoint
/api/dongdong/messages

### Parameters
#### Request Body
- **recipientId** (string) - Required - The ID of the message recipient.
- **message** (string) - Required - The content of the message.

### Response
#### Success Response (200)
- **messageId** (string) - The unique identifier for the sent message.
- **timestamp** (string) - The time the message was sent.

#### Response Example
```json
{
  "messageId": "msg-xyz-789",
  "timestamp": "2023-10-27T10:00:00Z"
}
```
```

--------------------------------

### Gateway Error Codes

Source: https://jos.jd.com/apilistnewdetail.html?first=440&second=442

List of common error codes returned by the API gateway.

```APIDOC
## Gateway Error Codes

### Description
A reference for understanding and handling errors returned by the API gateway.

### Error Codes
- **400 Bad Request**: The request was invalid or could not be understood.
- **401 Unauthorized**: Authentication failed or is missing.
- **403 Forbidden**: The authenticated user does not have permission to perform the requested action.
- **404 Not Found**: The requested resource could not be found.
- **500 Internal Server Error**: An unexpected error occurred on the server.
- **503 Service Unavailable**: The service is temporarily unavailable.
```
Tokens:
Raw