• Documentation >
• Apps >
• Marketing >
• Delesign

Delesign

The Delesign modules allow you to watch, create, update, search, and delete the projects in your Delesign account.

Getting Started with Delesign

Prerequisites

• A Delesign account

In order to use Delesign with Ibexa Connect, it is necessary to have a Delesign account. If you do not have one, you can create a Delesign account at delesign.com.

Note

The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!

Connecting to Delesign to Ibexa Connect

To connect your Delesign account to Ibexa Connect you need to obtain the API Key from your Delesign account and insert it in the Create a connection dialog in the Ibexa Connect module.

1. Log in to your Delesign account and open your Dashboard.

2. Click Integrations > Delesign API.

   

3. Copy the API Token to your clipboard.

   

4. Go to Ibexa Connect and open the Delesign module's Create a connection dialog.

   

5. In the Connection name field, enter a name for the connection.

6. In the API Token field, enter the token copied in step 3, and click Continue.

The connection has been established.

Projects

Search Projects

Lists Projects.

Limit	Set the maximum number of projects Ibexa Connect should return during one scenario execution cycle.
Type	Select the project type: Individual Company
Status	Select the project status: In Queue Active Completed

Gets a Project

Gets a project.

Project Status	Select the status of the project whose details you want to retrieve: In Queue Active Completed Enter the Project ID Manually
Project ID	Select the Project ID whose details you want to retrieve.

Create a Project

Creates a project.

Title	Enter a name for the project.
Type	Select the project type: Designs Development
Category	Select the category of the project. For example, Icon.
Description	Enter the project details.
Dimension	Enter the dimension of the project.
Target Audience	Enter the target audience for the project. For example, developers.
Timeframe	Enter the time
Inspiration	Enter the details which led to this project. For example, client requirements.
Script	Enter the script details which you want to include in the project. This is applicable only for the project type Video Editing, Motion Graphics, 2D Animation, Character Animation, Animated GIFs
Mockup Type	Select the mockup type. This is applicable only if the project type is Website Design Mockup, App Design Mockup.
Screen Mockup	Select the screen mockup details. This is applicable only if the project type is one of Website Design Mockup, App Design Mockup.
File Attachment	Enter the file URL address you want to add to the project.
File Types	Select the file type. For example, PNG, JPG.

Update a Project

Updates a project.

Project Status	Select the status of the project that you want to update: In Queue Active Completed Enter the Project ID Manually
Project ID	Select the Project ID whose details you want to update.
Title	Enter a name for the project.
Type	Select the project type: Designs Development
Category	Select the category of the project. For example, Icon.
Description	Enter the project details.
Dimension	Enter the dimension of the project.
Target Audience	Enter the target audience for the project. For example, developers.
Timeframe	Enter the time
Inspiration	Enter the details which led to this project. For example, client requirements.
Script	Enter the script details which you want to include in the project. This is applicable only for the project type Video Editing, Motion Graphics, 2D Animation, Character Animation, Animated GIFs
Mockup Type	Select the mockup type. This is applicable only if the project type is Website Design Mockup, App Design Mockup.
Screen Mockup	Select the screen mockup details. This is applicable only if the project type is one of Website Design Mockup, App Design Mockup.
File Attachment	Enter the file URL address you want to add to the project.
File Types	Select the file type. For example, PNG, JPG.

Delete a Project

Deletes a project.

Project Status	Select the status of the project you want to delete.
Project ID	Select the Project ID you want to delete.

Message

Create a Message

Creates a message.

Project Status	Select the status of the project in which you want to create a message: In Queue Active Completed Enter the Project ID Manually
Project ID	Select the Project ID in which you want to create a message.
Message	Enter the message text you want to add to the project.
File Attachment	Enter the file URL address you want to add to the message.

Other

Make an API Call

Performs an arbitrary authorized API call.

URL

Enter a path relative to https://api.delesign.com/. For example: /v1/projects/lists

For the list of available endpoints, refer to the Delesign API Documentation.

Method

Select the HTTP method you want to use:

GET

to retrieve information for an entry.

POST

to create a new entry.

PUT

to update/replace an existing entry.

PATCH

to make a partial entry update.

DELETE

to delete an entry.

Headers

Enter the desired request headers. You don't have to add authorization headers; we already did that for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.

Example of Use - List Projects

The following API call returns all the projects from your Delesign account:

URL:

/v1/projects/lists

Method:

GET

Query String:

Key:

Status

Value:

Active

Matches of the search can be found in the module's Output under Bundle > Body > data.

In our example, 4 projects were returned: