CJ Docs

# Development Documentation

  • Introduction
  • Call Flow
  • Debugging Methods
  • Rate Limits

# Introduction

The CJ API offers a rich set of capability interfaces that developers can use to achieve integration of enterprise services and enterprise WeChat with the help of interface capabilities which can be quickly previewed by directory navigation. The navigation is aggregated and grouped by functional blocks, such as address book, push, etc..

For the API development, the guideline is Development Documentation > Get Access Token > API 2.0.

All interfaces must use the HTTPS protocol, JSON data format and UTF8 encoding. The interface description format is as follows.

Request method: 
POST (HTTPS)
Request address: 
...
Request package body.
...
Parameter description.
...
Permission Description.
...
Return results.
...
Description of parameters.
...
  1. The request method. All requests shall meet the https protocol, distinguishing HttpGet and HttpPost requests.
  2. The request address. Case matters.
  3. The request package body and parameter description. You should indicates the request parameter example and description, which includes field meanings and value ranges. You should refer to this definition scope when designing data structures.
  4. The permission description. You should indicate the use range of the interface. By default, it can only view the data under the current account. No invocation scenario need your special attention.
  5. The return results and description of parameters. You should indicates the request parameter example and description. Please note that all interfaces have code and message in the return package when the call fails (while some interfaces do not return code and message on success). So it is a failure if the code is present and not 0. Otherwise it is a success (see the global error code for the meaning of code).

The message is for reference only and is subject to change, so it cannot be used to determine whether the call was successful.

# Interface call flow

img.png

Find the access token. Reference: documentation note.

  1. Cache and refresh access_token.
  2. You need to cache the access_token for subsequent calls to the interface. When the access_token is invalid or expired, it needs to be retrieved.
  3. Calling a specific business interface.

# Basic debugging methods

Tools, such as postman, can be used to troubleshoot problems. Reference: documentation note

# Limitations on the frequency of calls

To ensure our platform remains stable and fair for everyone, all APIs are rate-limited. Reference: Active call frequency limit

← Get Access-token →