GET https://api.dooki.com.br/v2/{alias}/config/merchant-credentials
Request de credenciais
{"active": true,"is_subdomain": true,"domain": "domain.com.br",}
Response de credenciais
{"data": {"id": 3,"active": true,"is_subdomain": false,"alias": "merchant_alias","domain": "domain.com.br",}}
Parâmetro | Tipo | Obrigatório | Descrição |
active | boolean | Sim | Status da loja. |
is_subdomain | boolean | Sim | Marca se a loja roda em um subdomínio. |
domain | string | Sim | Domínio da loja. |
PUT https://api.dooki.com.br/v2/{alias}/config/merchant-credentials/{id}
GET https://api.dooki.com.br/v2/{alias}/config/merchant-data
Request de dados da loja
{"maintenance": false,"name": "Merchant Name","razao_social": "Razao Social","email_contact": "merchant@domain.com","email_sales": "merchant@domain.com","description": "Merchant Description","owner_name": "John Snow","phone": "99 9999999","whatsapp": "99 9999999","ie": "0000","cnpj": "00.000.0000/0001-32","cpf" : null,"full_address": "Address Store","zipcode": "14940000","products_per_page": 10,"logo_url": "http://url.to/logo.jpg","icon_url": "http://url.to/logo.jpg","facebook_url": null,"instagram_url": null,"youtube_url": null,"pinterest_url": null}
Response de dados da loja
{"data": {"id": 9,"maintenance": false,"type": "j","name": "Loja de Teste","razao_social": "aaaaa","email_contact": "email@email.com.br","email_sales": "email@email.com.br","description": "description","owner_name": "Owner","phone": "(12) 31131-3131","whatsapp": null,"ie": "a","cnpj": "31.903.676/0001-19","cpf": null,"full_address": ", - ","address_street": null,"address_number": null,"address_complement": null,"address_neighborhood": null,"address_city": "Ibitinga","address_state": "SP","zipcode": "14940-000","billing_document_type": "j","billing_name": "Mimi Enxovais","billing_document": "31.903.676/0001-19","products_per_page": 15,"logo_url": "https://s3.amazonaws.com/images.yampi.me/assets/stores/mimienxovais/uploads/logo/mimienxovais.png","icon_url": "https://s3.amazonaws.com/images.yampi.me/assets/stores/mimienxovais/uploads/icon/apple-touch-icon-iphone-retina.png","facebook_url": null,"instagram_url": null,"youtube_url": null,"pinterest_url": null}}
PUT https://api.dooki.com.br/v2/{alias}/config/merchant-data/{id}
Parâmetro | Tipo | Obrigatório | Descrição |
maintenance | boolean | Sim | Marca se a loja está em manutenção. |
name | string | Sim | Nome da loja. |
description | string | Sim | Descrição da loja. |
razao_social | string | Não | Razão social da loja. |
email_contact | string | Sim | E-mail de contato da loja. |
email_sales | string | Sim | E-mail de vendas da loja. |
owner_name | string | Sim | Nome do proprietário da loja. |
phone | string | Não | Telefone da loja. |
string | Não | Whatsapp da loja. | |
ie | string | Não | Inscrição Estadual da loja. |
cnpj | string | Não | CNPJ da loja. |
cpf | string | Não | CPF do proprietário. |
full_address | string | Não | Endereço da loja. |
address_street | string | Sim | Rua da loja. |
address_number | string | Sim | Número da loja. |
address_complement | string | Não | Complemento da loja. |
address_neighborhood | string | Sim | Bairro da loja. |
address_city | string | Sim | Cidade da loja. |
address_state | string | Sim | Estado da loja. |
zipcode | string | Sim | CEP da loja. |
products_per_page | int | Sim | Números de produtos por página. |
logo_url | string | Não | URL do logotipo da loja. |
icon_url | string | Não | URL do ícone da loja. |
facebook_url | string | não | URL do facebook da loja da loja. |
instagram_url | string | não | URL do instagram da loja. |
youtube_url | string | não | URL do youtube da loja. |
pinterest_url | string | não | URL do pinterest da loja. |
GET https://api.dooki.com.br/v2/{alias}/config/checkout
Request de configuração do checkout
{"sequential_sale_number": true,"delivery_working_days": true,"show_shipping_in_cart": true,"show_products_links": true,"show_promocode": true,"max_daily_sales_by_ip": 3,"currency": "R$","person_type": "all","text_footer": null,"text_shipping": "O prazo de entrega começa a contar apenas quando o pagamento for confirmado","text_billet": null,"text_card": null,"redirect_url_billet": null,"redirect_url_card": null,"redirect_url_deposit": null}
Response de dados da loja
{"data": {"id": 1,"sequential_sale_number": true,"delivery_working_days": true,"show_shipping_in_cart": true,"show_products_links": true,"show_promocode": true,"max_daily_sales_by_ip": 3,"currency": "R$","text_footer": null,"person_type": "all","text_shipping": "O prazo de entrega começa a contar apenas quando o pagamento for confirmado","text_billet": null,"text_card": null,"text_deposit": null,"redirect_url_billet": null,"redirect_url_card": null,"redirect_url_deposit": null}}
PUT https://api.dooki.com.br/v2/{alias}/config/checkout/{id}
Parâmetro | Tipo | Obrigatório | Descrição |
sequential_sale_number | boolean | Sim | Marca se os números dos pedidos serão sequenciais. |
delivery_working_days | boolean | Sim | Marca se o prazo de entrega será em dias úteis. |
show_shipping_in_cart | boolean | Sim | Marca se o cálculo de frete no carrinho estará visível. |
show_products_links | boolean | Sim | Marca se os produtos no carrinho terão links. |
show_promocode | boolean | Sim | Marca se os campo de cupom de desconto será visível. |
max_daily_sales_by_ip | int | Sim | Máximo de pedidos por dia por IP. Mínimo: |
currency | string | Sim | Moeda monetária. Valores aceitos: |
person_type | string | Não | Tipos de cadastro aceitos. Valores: |
text_footer | string | Não | Texto no rodapé do checkout. |
text_shipping | string | Não | Texto de apoio para entregas. |
text_billet | string | Não | Texto de apoio para boleto bancário. |
text_card | string | Não | Texto de apoio para cartão de crédito. |
text_deposit | string | Não | Texto de apoio para depósito. |
redirect_url_billet | string | Não | URL de redirecionamento quando o pagamento for por boleto bancário. |
redirect_url_card | string | Não | URL de redirecionamento quando o pagamento for por cartão de crédito. |
redirect_url_deposit | string | Não | URL de redirecionamento quando o pagamento for por depósito. |
GET https://api.dooki.com.br/v2/{alias}/config/blocked-ips
Request
{"ip": "127.0.0.1",}
Response
{"data": [{"id": 1,"name": "127.0.0.1",},]}
POST https://api.dooki.com.br/v2/{alias}/config/blocked-ips
Parâmetro | Tipo | Obrigatório | Descrição |
ip | string | Sim | Número de IP. |
GET https://api.dooki.com.br/v2/{alias}/config/blocked-ips/{id}
PUT https://api.dooki.com.br/v2/{alias}/config/blocked-ips/{id}
DELETE https://api.dooki.com.br/v2/{alias}/config/blocked-ips/{id}
A plataforma possui um recurso de disparo automático de e-mails de recuperação de carrinho.
GET https://api.dooki.com.br/v2/{alias}/config/carts
Request
{"email_subject": "{name}, os produtos estão te esperando!","sms_subject": "{name}, os produtos estão te esperando!","email_frequency": 1,"email_hours_delay": 1,"promocode_in_first_email": false}
Response
{"data": [{"id": 1,"email_subject": "{name}, os produtos estão te esperando!","sms_subject": "{name}, os produtos estão te esperando!","email_frequency": 1,"email_hours_delay": 1,"promocode_in_first_email": false},]}
POST https://api.dooki.com.br/v2/{alias}/config/carts
Só é permitida uma configuração de carrinho abandonado.
Parâmetro | Tipo | Obrigatório | Descrição |
email_subject | string | Sim | Assunto do e-mail de recuperação. Você pode usar a tag |
sms_subject | string | Não | Mensagem customizada do SMS. |
email_frequency | int | Sim | Número de dias que o sistema enviará o e-mail. Máximo: |
email_hours_delay | int | Sim | Atraso (em horas) para o primeiro disparo. Padrão: |
promocode_in_first_email | boolean | Sim | Marca se o sistema deve enviar o cupom de desconto associado no primeiro e-mail. |
GET https://api.dooki.com.br/v2/{alias}/config/carts/{id}
PUT https://api.dooki.com.br/v2/{alias}/config/carts/{id}
DELETE https://api.dooki.com.br/v2/{alias}/config/carts/{id}
Só é permitida uma configuração por serviço.
Includes disponíveis: config, form
GET https://api.dooki.com.br/v2/{alias}/config/services
GET https://api.dooki.com.br/v2/{alias}/config/services/{service}
Esse tipo de filtro não utiliza a sintaxe global. Neste caso, o parâmetro é passado individualmente via query string na URL.
Parâmetro | Tipo | Descrição |
groupedByCategory | boolean | Agrupa os serviços de acordo com suas categorias |
GET https://api.dooki.com.br/v2/{alias}/config/services?actives=true
Response de todos os serviços
{"data": [{"alias": "clearsale_form","name": "Clearsale Form","category": "antifraud","active_config": true,"params": {"data": ["env","code"]}},{"alias": "clearsale_total","name": "Clearsale Total","category": "antifraud","active_config": false,"params": {"data": ["env","entity_code","app_fingerprint"]}},]}
GET https://api.dooki.com.br/v2/{alias}/config/services/{serviceAlias}/settings
POST https://api.dooki.com.br/v2/{alias}/config/services/{serviceAlias}/settings
Request para criar ou atualizar uma configuração
{"active": true,"service_alias": "intelipost","params": {"origin_zipcode": "14940000","api_key": "api_key"}}
Response de configuração de serviço
{"data": [{"id": 33,"service_alias": "intelipost","active": true,"params": {"origin_zipcode": "14940000","api_key": "api_key"},}],}
PUT https://api.dooki.com.br/v2/{alias}/config/services/{serviceAlias}/settings/{id}
DELETE https://api.dooki.com.br/v2/{alias}/config/services/{serviceAlias}/settings/{id}
GET https://api.dooki.com.br/v2/{alias}/config/photos
Request
{"width_small": 50,"height_small": 50,"width_thumb": 100,"height_thumb": 100,"width_medium": 500,"height_medium": 500,"width_large": 1000,"height_large": 1000}
Response
{"data": [{"id": 1,"width_small": 50,"height_small": 50,"width_thumb": 100,"height_thumb": 100,"width_medium": 500,"height_medium": 500,"width_large": 1000,"height_large": 1000},]}
POST https://api.dooki.com.br/v2/{alias}/config/photos
Só é permitida uma configuração de foto.
Parâmetro | Tipo | Obrigatório | Descrição |
width_small | int | Sim | Largura da foto |
height_small | int | Sim | Altura da foto |
width_thumb | int | Sim | Largura da foto |
height_thumb | int | Sim | Altura da foto |
width_medium | int | Sim | Largura da foto |
height_medium | int | Sim | Altura da foto |
width_large | int | Sim | Largura da foto |
height_large | int | Sim | Altura da foto |
GET https://api.dooki.com.br/v2/{alias}/config/photos/{id}
PUT https://api.dooki.com.br/v2/{alias}/config/photos/{id}
DELETE https://api.dooki.com.br/v2/{alias}/config/photos/{id}
GET https://api.dooki.com.br/v2/{alias}/config/emails
Request
{"host": "smtp.server.com","username": "username@server.com","password": "123456","encryption": "ssl","port": 465,"from": "contact@server.com","name": "Merchant Name"}
Response
{"data": [{"id": 1,"host": "smtp.server.com","username": "username@server.com","password": "123456","encryption": "ssl","port": 465,"from": "contact@server.com","name": "Merchant Name"},]}
POST https://api.dooki.com.br/v2/{alias}/config/emails
Só é permitida uma configuração de e-mail.
Parâmetro | Tipo | Obrigatório | Descrição |
host | string | Sim | Servidor de saída. |
username | string | Sim | Usuário de autenticação. |
password | string | Sim | Senha de autenticação. |
encryption | string | Sim | Tipo de criptografia. |
port | int | Sim | Porta de saída. |
from | string | Sim | E-mail do remetente das mensagens. |
name | string | Sim | Nome do remetente das mensagens. |
GET https://api.dooki.com.br/v2/{alias}/config/emails/{id}
PUT https://api.dooki.com.br/v2/{alias}/config/emails/{id}
DELETE https://api.dooki.com.br/v2/{alias}/config/emails/{id}
Overview geral das configuracões essenciais para o funcionamento correto da loja
GET https://api.dooki.com.br/v2/{alias}/config/overview
Response
{"data": [{"title": "Cadastre uma planilha de frete","message": "Baixe nossa planilha modelo, atualize os valores e cadastre na plataforma. Mesmo que você tenha uma integração, aconselhamos você cadastrar uma planilha de frete como backup.","icon": "carrier","url": "http://king.test/config/logistics"},{"title": "Cadastre informações sobre sua loja","message": "E-mail, razão social, CNPJ, descrição da loja e endereço são itens essenciais para mecanismos de busca como o Google e também para disponibilizar a seus clientes.","icon": "store-config","url": "http://king.testconfig/merchant-data/edit"}],}