Skip to main content

Quick Start

Let's discover Jinko API in less than 5 minutes.

01. Open project settings

  1. Click on the project setting wheel next to the project name
  2. Then click on "API Access" tab, top right

02. Create a new token

  1. Click on "Add API Key"
  2. Fill the form then click on "Create"
  3. Copy the secret api token

03. Test your connection

To verify your API token is working, you can test it by querying our authentication endpoint.

  1. Send a GET request to https://api.jinko.ai/app/v1/auth/check.

  2. Make sure to include your API token and project ID in the headers as follows:

    curl --request GET \\
    --url https://api.jinko.ai/app/v1/auth/check \\
    --header 'Accept: application/json' \\
    --header 'Authorization: Bearer YOUR_API_KEY' \\
    --header 'X-jinko-project-id: YOUR_JINKO_PROJECT_ID'
  3. If your token is valid, the response should indicate

    {
    "status": "authenticated"
    }

For more details on this endpoint and to try it directly from our documentation, visit the API Documentation.

04. Explore the API