Get StartedDaruma Formats
Daruma API

Overview

Quick Start

API Reference

Daruma SDK

You can start using Daruma's REST API Within a few minutes:

Before you begin

To get started, create a Daruma account or log in.

This guide walks you through a simple interaction with the Daruma REST API: Import a design file and convert it to obtain JSON files and assets. For more details and additional API functionality, refer to the API reference and explore the available endpoints.

Step 1 - Get your API token

Enter the Daruma Dashboard page, click on the avatar and select API token. Now, you can create your first API token from the page.

API Token

In the following steps, you will need this generated token to verify the request.

Step 2 - Create a Daruma

Use the /api/daruma/import/file endpoint send a request to the Daruma server to upload the design file.

$VGG_DARUMA_TOKEN is a variable, please replace it with the actual Daruma authorization token generated in Step 1.

bash
curl -X POST 'https://verygoodgraphics.com/api/daruma/import/file' \
  -H 'Authorization: Bearer '"$VGG_DARUMA_TOKEN"'' \
  -H "Content-Type: application/json" \
  --data '{"filename":"string"}'

In this step, you will receive the darumaImport.id returned by the API response, please note that it is different from darumaId. This step will return a URL.

Step 3 - Upload a design file

You need to fill the URL parameters returned by the previous step into the url_from_create_api_endpoint. Locate the Sketch, Figma, or Adobe Illustrator file on your computer and enter its exact path in the -F 'file=@"/path/to/your/file"'.

bash
curl -X PUT 'site_url + url_from_create_api_endpoint' \
  -F 'file=@"/path/to/your/file"'

This call should return a status code of 200.

Step 4 - Covert a design file

Use the /api/daruma/import/convert endpoint to send a request for converting design file. Please note that importId and quality need to be replaced according to the actual situation. The generated artboard image quality has four levels, please choose according to your needs. (1-4, default: 2)

bash
curl -X POST 'https://verygoodgraphics.com/api/daruma/import/convert?importId=your_import_id&quality=your_quality_level' \
  -H 'Authorization: Bearer '"$VGG_DARUMA_TOKEN"'' \
  -H "Content-Type: application/json"

This step will return a taskId parameter. This call should return a status code of 200.

Step 5 - Get a conversion status

Send a request to /api/daruma/import/status/task endpoint to confirm the conversion status of the design file and ensure that the conversion has been completed. Please fill in the returned api response taskId before sending the request.

bash
curl -X GET 'https://verygoodgraphics.com/api/daruma/import/status/task?taskId=string' \
  -H 'Authorization: Bearer '"$VGG_DARUMA_TOKEN"''

Step 6 - Get JSON data and images in file

Use the /api/daruma/get/design endpoint to retrieve JSON data for design file.

bash
curl -X GET 'https://verygoodgraphics.com/api/daruma/get/design?darumaId=string' \
  -H 'Authorization: Bearer '"$VGG_DARUMA_TOKEN"''

The API response will return a URL. This call should return a status code of 200.

Use the /api/daruma/get/resource/artboards endpoint to obtain rendered images of design file.

bash
curl -X GET 'https://verygoodgraphics.com/api/daruma/get/resource/artboards?darumaId=string' \
  -H 'Authorization: Bearer '"$VGG_DARUMA_TOKEN"''

The API response will return a URL List. This call should return a status code of 200.

For more information about the Daruma formats and how to invoke different interfaces, please refer to the API reference.

Daruma Feedback