GitCode REST API

The GitCode API offers powerful features, enabling developers to interact programmatically with resources on GitCode. This documentation will guide you on how to use the GitCode API, covering topics such as making effective API requests, authentication methods, status codes, pagination, path parameters, and more.

Effective API Requests

To make a request to the GitCode API, you must include the api path and specify the API version. The current available version is /api/v5.

Here is a basic example of making a request to the GitCode API:

curl "https://api.gitcode.com/api/v5/users/{username}"

Authentication

Most GitCode API requests require authentication, or they will only return public data if no authentication is provided. The documentation for each endpoint will specify whether authentication is required.

You can authenticate to the GitCode API using a Personal Access Token .

If the authentication information is invalid or missing, GitCode will return an error with the status code 401:

{
  "message": "401 Unauthorized"
}

Authorization

You can authenticate using the API by passing your Personal Access Token in the Authorization header.

Example of the Personal Access Token in the Request Header:

curl --location 'https://api.gitcode.com/api/v5/user' \
--header 'Authorization: Bearer {your-token}'

PRIVATE-TOKEN

You can authenticate by passing your Personal Access Token in the PRIVATE-TOKEN header.

Example of the Personal Access Token in the Request Header:

curl --location 'https://api.gitcode.com/api/v5/user' \
--header 'PRIVATE-TOKEN: {your-token}'

access_token

You can authenticate by passing your Personal Access Token in the access_token query parameter.

Example of the Personal Access Token in the Query:

curl  "https://api.gitcode.com/api/v5/users/{username}?access_token={your-token}"

Response Codes

The GitCode API returns different status codes based on the context and operation. This helps you understand what went wrong if a request results in an error.

The following table outlines the general behavior of the GitCode API functions:

Here are the possible return codes for GitCode API requests: