Design Builder API v2
- Base URL:
https://design-builder-api.epilot.io - Full API Docs: https://docs.epilot.io/api/design
Usage
import { epilot } from '@epilot/sdk'
epilot.authorize(() => '<token>')
const { data } = await epilot.design.getAllDesigns(...)
Tree-shakeable import
import { getClient, authorize } from '@epilot/sdk/design'
const designClient = getClient()
authorize(designClient, () => '<token>')
const { data } = await designClient.getAllDesigns(...)
Operations
design-builder
getAllDesignsaddDesigngetDesigndeleteDesignupdateDesigngetThemeFromDesignuploadFilegetFilesgetConsumerDesignaddConsumerremoveConsumer
Schemas
UploadFileReqUploadFileResGetFilesResGetAllDesignsResGetBrandsResAddDesignReqAddDesignResGetDesignResUpdateDesignReqItemMetadaAddConsumerReqDesignItemBrandItemCustom_StyleJourneyConsumerDataWidgetDataCustomerPortalDataLogoDataPaletteDataTypographyDataShapeDataFontDataFontResponseUrlWidgetPortalDataErrorRespFileData
getAllDesigns
Scan all designs linked to a organization, based in orgId attribute from JWT auth token
GET /v1/designs
const { data } = await client.getAllDesigns()
Response
[
{
"designs": [
{
"id": "string",
"created_at": "2021-01-30T08:30:00Z",
"created_by": "string",
"edited": true,
"last_modified_at": "string",
"brand_id": "string",
"brand_name": "string",
"user": {
"emailaddress": "string",
"fullname": "string",
"name": "string",
"userid": "string"
},
"style_name": "string",
"style": {
"logo": {
"main": {
"name": "string",
"display_name": "string",
"file_type": "LOGO",
"s3_object_key": "string",
"url": "string"
}
},
"palette": {
"primary": "string",
"secondary": "string",
"error": "string",
"background": "string",
"paper": "string",
"navbar": "string",
"portal_login_background": "string"
},
"typography": {
"font": {
"font_id": "string",
"font_name": "string",
"font_family": "string",
"font_weight_regular": "string",
"font_weight_medium": "string",
"font_weight_bold": "string",
"urls": [
{
"type": "WOFF2",
"url": "string"
}
]
},
"primary": "string",
"secondary": "string"
},
"shape": {
"border_radius": 0
},
"consumer": {
"widgets": [
{
"id": "string",
"name": "string"
}
],
"customer_portals": [
{
"id": "string",
"name": "string"
}
]
}
},
"is_default": true,
"custom_theme": "string",
"use_custom_theme": true,
"design_tokens": {
"coupon": "string",
"cashback": "string",
"custom_css": "string"
}
}
]
}
]
addDesign
Create a brand new design linked to a organization, based in orgId attribute from JWT auth token
POST /v1/designs
const { data } = await client.addDesign(
null,
{
design: {
brand_id: 'string',
brand_name: 'string',
user: {
emailaddress: 'string',
fullname: 'string',
name: 'string',
userid: 'string'
},
style_name: 'string',
style: {
logo: {
main: {
name: 'string',
display_name: 'string',
file_type: 'LOGO',
s3_object_key: 'string',
url: 'string'
}
},
palette: {
primary: 'string',
secondary: 'string',
error: 'string',
background: 'string',
paper: 'string',
navbar: 'string',
portal_login_background: 'string'
},
typography: {
font: {
font_id: 'string',
font_name: 'string',
font_family: 'string',
font_weight_regular: 'string',
font_weight_medium: 'string',
font_weight_bold: 'string',
urls: [
{
type: 'WOFF2',
url: 'string'
}
]
},
primary: 'string',
secondary: 'string'
},
shape: {
border_radius: 0
},
consumer: {
widgets: [
{
id: 'string',
name: 'string'
}
],
customer_portals: [
{
id: 'string',
name: 'string'
}
]
}
},
is_default: true,
custom_theme: 'string',
use_custom_theme: true,
design_tokens: {
coupon: 'string',
cashback: 'string',
custom_css: 'string'
}
}
},
)
Response
{
"design": {
"id": "string",
"created_at": "2021-01-30T08:30:00Z",
"created_by": "string",
"edited": true,
"last_modified_at": "string",
"brand_id": "string",
"brand_name": "string",
"user": {
"emailaddress": "string",
"fullname": "string",
"name": "string",
"userid": "string"
},
"style_name": "string",
"style": {
"logo": {
"main": {
"name": "string",
"display_name": "string",
"file_type": "LOGO",
"s3_object_key": "string",
"url": "string"
}
},
"palette": {
"primary": "string",
"secondary": "string",
"error": "string",
"background": "string",
"paper": "string",
"navbar": "string",
"portal_login_background": "string"
},
"typography": {
"font": {
"font_id": "string",
"font_name": "string",
"font_family": "string",
"font_weight_regular": "string",
"font_weight_medium": "string",
"font_weight_bold": "string",
"urls": [
{
"type": "WOFF2",
"url": "string"
}
]
},
"primary": "string",
"secondary": "string"
},
"shape": {
"border_radius": 0
},
"consumer": {
"widgets": [
{
"id": "string",
"name": "string"
}
],
"customer_portals": [
{
"id": "string",
"name": "string"
}
]
}
},
"is_default": true,
"custom_theme": "string",
"use_custom_theme": true,
"design_tokens": {
"coupon": "string",
"cashback": "string",
"custom_css": "string"
}
}
}
getDesign
Search for a especific design owned by user organization
GET /v1/designs/{designId}
const { data } = await client.getDesign({
designId: 'example',
})
Response
{
"design": {
"id": "string",
"created_at": "2021-01-30T08:30:00Z",
"created_by": "string",
"edited": true,
"last_modified_at": "string",
"brand_id": "string",
"brand_name": "string",
"user": {
"emailaddress": "string",
"fullname": "string",
"name": "string",
"userid": "string"
},
"style_name": "string",
"style": {
"logo": {
"main": {
"name": "string",
"display_name": "string",
"file_type": "LOGO",
"s3_object_key": "string",
"url": "string"
}
},
"palette": {
"primary": "string",
"secondary": "string",
"error": "string",
"background": "string",
"paper": "string",
"navbar": "string",
"portal_login_background": "string"
},
"typography": {
"font": {
"font_id": "string",
"font_name": "string",
"font_family": "string",
"font_weight_regular": "string",
"font_weight_medium": "string",
"font_weight_bold": "string",
"urls": [
{
"type": "WOFF2",
"url": "string"
}
]
},
"primary": "string",
"secondary": "string"
},
"shape": {
"border_radius": 0
},
"consumer": {
"widgets": [
{
"id": "string",
"name": "string"
}
],
"customer_portals": [
{
"id": "string",
"name": "string"
}
]
}
},
"is_default": true,
"custom_theme": "string",
"use_custom_theme": true,
"design_tokens": {
"coupon": "string",
"cashback": "string",
"custom_css": "string"
}
}
}
deleteDesign
Search and delete for a especific design owned by user organization
DELETE /v1/designs/{designId}
const { data } = await client.deleteDesign({
designId: 'example',
})
updateDesign
Update a especific design owned by user organization
PUT /v1/designs/{designId}
const { data } = await client.updateDesign(
{
designId: 'example',
},
{
design: {
brand_id: 'string',
brand_name: 'string',
user: {
emailaddress: 'string',
fullname: 'string',
name: 'string',
userid: 'string'
},
style_name: 'string',
style: {
logo: {
main: {
name: 'string',
display_name: 'string',
file_type: 'LOGO',
s3_object_key: 'string',
url: 'string'
}
},
palette: {
primary: 'string',
secondary: 'string',
error: 'string',
background: 'string',
paper: 'string',
navbar: 'string',
portal_login_background: 'string'
},
typography: {
font: {
font_id: 'string',
font_name: 'string',
font_family: 'string',
font_weight_regular: 'string',
font_weight_medium: 'string',
font_weight_bold: 'string',
urls: [
{
type: 'WOFF2',
url: 'string'
}
]
},
primary: 'string',
secondary: 'string'
},
shape: {
border_radius: 0
},
consumer: {
widgets: [
{
id: 'string',
name: 'string'
}
],
customer_portals: [
{
id: 'string',
name: 'string'
}
]
}
},
is_default: true,
custom_theme: 'string',
use_custom_theme: true,
design_tokens: {
coupon: 'string',
cashback: 'string',
custom_css: 'string'
}
}
},
)
getThemeFromDesign
Search for a especific design owned by user organization and parse them to a new or old theme
GET /v1/designs/{designId}/parse
const { data } = await client.getThemeFromDesign({
designId: 'example',
orgId: 'example',
theme: 'example',
})
Response
{}
uploadFile
Upload a new file for the user organization bucket
POST /v1/designs/files
const { data } = await client.uploadFile()
Response
{
"name": "string",
"display_name": "string",
"file_type": "LOGO",
"s3_object_key": "string",
"url": "string"
}
getFiles
List all files for the user organization bucket
GET /v1/designs/files
const { data } = await client.getFiles({
type: 'example',
})
Response
[
{
"name": "string",
"display_name": "string",
"file_type": "LOGO",
"s3_object_key": "string",
"url": "string"
}
]
getConsumerDesign
Search for a especific design owned by user organization
GET /v1/designs/consumer/{application}/{consumerId}
const { data } = await client.getConsumerDesign({
consumerId: 'example',
application: 'example',
})
Response
{
"design": {
"id": "string",
"created_at": "2021-01-30T08:30:00Z",
"created_by": "string",
"edited": true,
"last_modified_at": "string",
"brand_id": "string",
"brand_name": "string",
"user": {
"emailaddress": "string",
"fullname": "string",
"name": "string",
"userid": "string"
},
"style_name": "string",
"style": {
"logo": {
"main": {
"name": "string",
"display_name": "string",
"file_type": "LOGO",
"s3_object_key": "string",
"url": "string"
}
},
"palette": {
"primary": "string",
"secondary": "string",
"error": "string",
"background": "string",
"paper": "string",
"navbar": "string",
"portal_login_background": "string"
},
"typography": {
"font": {
"font_id": "string",
"font_name": "string",
"font_family": "string",
"font_weight_regular": "string",
"font_weight_medium": "string",
"font_weight_bold": "string",
"urls": [
{
"type": "WOFF2",
"url": "string"
}
]
},
"primary": "string",
"secondary": "string"
},
"shape": {
"border_radius": 0
},
"consumer": {
"widgets": [
{
"id": "string",
"name": "string"
}
],
"customer_portals": [
{
"id": "string",
"name": "string"
}
]
}
},
"is_default": true,
"custom_theme": "string",
"use_custom_theme": true,
"design_tokens": {
"coupon": "string",
"cashback": "string",
"custom_css": "string"
}
}
}
addConsumer
Add a consumer that uses a specific design
PUT /v1/designs/addConsumer/{application}/{designId}
const { data } = await client.addConsumer(
{
designId: 'example',
application: 'example',
},
{
consumer_id: 'string',
consumer_name: 'string',
should_delete: 'string'
},
)
removeConsumer
Remove a consumer that uses a specific design
PUT /v1/designs/removeConsumer/{application}/{designId}
const { data } = await client.removeConsumer(
{
designId: 'example',
application: 'example',
},
{
consumer_id: 'string',
consumer_name: 'string',
should_delete: 'string'
},
)
Schemas
UploadFileReq
type UploadFileReq = {
file_type: "LOGO" | "FONT"
file_data: string // base64
display_name?: string
file_name: string
}
UploadFileRes
type UploadFileRes = {
name: string
display_name?: string
file_type?: "LOGO" | "FONT"
s3_object_key: string
url: string
}
GetFilesRes
type GetFilesRes = Array<{
name: string
display_name?: string
file_type?: "LOGO" | "FONT"
s3_object_key: string
url: string
}>
GetAllDesignsRes
type GetAllDesignsRes = {
designs?: Array<{
id?: string
created_at?: string
created_by?: string
edited: boolean
last_modified_at?: string
brand_id?: string
brand_name?: string
user?: {
emailaddress?: { ... }
fullname?: { ... }
name?: { ... }
userid?: { ... }
}
style_name: string
style: {
logo?: { ... }
palette: { ... }
typography: { ... }
shape?: { ... }
consumer: { ... }
}
is_default?: boolean
custom_theme?: string
use_custom_theme?: boolean
design_tokens?: {
coupon?: { ... }
cashback?: { ... }
custom_css?: { ... }
}
}>
}
GetBrandsRes
type GetBrandsRes = {
brands?: Array<{
id: string
name: string
created_by?: string
created_date?: string
main_brand?: string
organization_id?: string
updated_date?: string
updated_by?: string
status?: string
}>
}
AddDesignReq
type AddDesignReq = {
design: {
brand_id?: string
brand_name?: string
user?: {
emailaddress?: { ... }
fullname?: { ... }
name?: { ... }
userid?: { ... }
}
style_name: string
style: {
logo?: { ... }
palette: { ... }
typography: { ... }
shape?: { ... }
consumer: { ... }
}
is_default?: boolean
custom_theme?: string
use_custom_theme?: boolean
design_tokens?: {
coupon?: { ... }
cashback?: { ... }
custom_css?: { ... }
}
}
}
AddDesignRes
type AddDesignRes = {
design?: {
id?: string
created_at?: string
created_by?: string
edited: boolean
last_modified_at?: string
brand_id?: string
brand_name?: string
user?: {
emailaddress?: { ... }
fullname?: { ... }
name?: { ... }
userid?: { ... }
}
style_name: string
style: {
logo?: { ... }
palette: { ... }
typography: { ... }
shape?: { ... }
consumer: { ... }
}
is_default?: boolean
custom_theme?: string
use_custom_theme?: boolean
design_tokens?: {
coupon?: { ... }
cashback?: { ... }
custom_css?: { ... }
}
}
}
GetDesignRes
type GetDesignRes = {
design?: {
id?: string
created_at?: string
created_by?: string
edited: boolean
last_modified_at?: string
brand_id?: string
brand_name?: string
user?: {
emailaddress?: { ... }
fullname?: { ... }
name?: { ... }
userid?: { ... }
}
style_name: string
style: {
logo?: { ... }
palette: { ... }
typography: { ... }
shape?: { ... }
consumer: { ... }
}
is_default?: boolean
custom_theme?: string
use_custom_theme?: boolean
design_tokens?: {
coupon?: { ... }
cashback?: { ... }
custom_css?: { ... }
}
}
}
UpdateDesignReq
type UpdateDesignReq = {
design: {
brand_id?: string
brand_name?: string
user?: {
emailaddress?: { ... }
fullname?: { ... }
name?: { ... }
userid?: { ... }
}
style_name: string
style: {
logo?: { ... }
palette: { ... }
typography: { ... }
shape?: { ... }
consumer: { ... }
}
is_default?: boolean
custom_theme?: string
use_custom_theme?: boolean
design_tokens?: {
coupon?: { ... }
cashback?: { ... }
custom_css?: { ... }
}
}
}
ItemMetada
type ItemMetada = {
id?: string
created_at?: string
created_by?: string
edited?: boolean
last_modified_at?: string
}
AddConsumerReq
type AddConsumerReq = {
consumer_id: string
consumer_name: string
should_delete?: string
}
DesignItem
type DesignItem = {
brand_id?: string
brand_name?: string
user?: {
emailaddress?: string
fullname?: string
name?: string
userid?: string
}
style_name: string
style: {
logo?: {
main?: { ... }
}
palette: {
primary: { ... }
secondary: { ... }
error: { ... }
background: { ... }
paper: { ... }
navbar: { ... }
portal_login_background?: { ... }
}
typography: {
font: { ... }
primary: { ... }
secondary: { ... }
}
shape?: {
border_radius?: { ... }
}
consumer: {
widgets: { ... }
customer_portals: { ... }
}
}
is_default?: boolean
}
BrandItem
type BrandItem = {
id: string
name: string
created_by?: string
created_date?: string
main_brand?: string
organization_id?: string
updated_date?: string
updated_by?: string
status?: string
}
Custom_Style
type Custom_Style = {
custom_theme?: string
use_custom_theme?: boolean
}
Journey
type Journey = {
design_tokens?: {
coupon?: string
cashback?: string
custom_css?: string
}
}
ConsumerData
type ConsumerData = {
widgets: Array<{
id: string
name: string
}>
customer_portals: Array<{
id: string
name: string
}>
}
WidgetData
type WidgetData = {
id: string
name: string
}
CustomerPortalData
type CustomerPortalData = {
id: string
name: string
}
LogoData
type LogoData = {
main?: {
name: string
display_name?: string
file_type?: "LOGO" | "FONT"
s3_object_key: string
url: string
}
}
PaletteData
type PaletteData = {
primary: string
secondary: string
error: string
background: string
paper: string
navbar: string
portal_login_background?: string
}
TypographyData
type TypographyData = {
font: {
font_id: string
font_name: string
font_family?: string
font_weight_regular?: string
font_weight_medium?: string
font_weight_bold?: string
urls: Array<{
type?: { ... }
url?: { ... }
}>
}
primary: string
secondary: string
}
ShapeData
type ShapeData = {
border_radius?: number
}
FontData
type FontData = {
font_id: string
font_name: string
font_family?: string
font_weight_regular?: string
font_weight_medium?: string
font_weight_bold?: string
urls: Array<{
type?: "WOFF2" | "WOFF" | "TTF" | "EOT"
url?: string
}>
}
FontResponseUrl
type FontResponseUrl = {
type?: "WOFF2" | "WOFF" | "TTF" | "EOT"
url?: string
}
WidgetPortalData
type WidgetPortalData = {
id: string
name: string
}
ErrorResp
type ErrorResp = {
message?: string
}
FileData
type FileData = {
name: string
display_name?: string
file_type?: "LOGO" | "FONT"
s3_object_key: string
url: string
}