logo
Documentation Powered by ReDoc

Sismotel - Cupom de Desconto (1.0.0)

Atendimento Microtecs: atendimento@microtecs.com.br

Esta é uma especificação da API para integração de cupom de descontos com o sistema Sismotel.

Introdução

Esta especificação é o ponto de partida para entender o fluxo de integração de cupom de desconto com o sistema Sismotel.

Cupom de Desconto

API de Cupom de Desconto do Sismotel fornece todo o conhecimento necessário para a integração de sistemas terceiros. O foco desta API é suprir a necessidade de cupons de descontos feitos nos sites dos moteleiros.

Cancelamento

O cupom de desconto pode ser cancelado pela api, somente se ainda não foi usado.

Dúvidas

TOKEN = Token do motel, fornecido pela Microtecs com autorização do Motel.
SOFTHOUSE = Token da Softhouse, fornecido pela Microtecs. Envie um e-mail para atendimento@microtecs.com.br com os dados: nome, email e telefone da softhouse para solicitar o cadastro e o token.

Cupons de Descontos

Operações relacionadas aos cupons de descontos do motel.

Retorna todos aos cupons de descontos.

Recupera todos aos cupons de descontos realizadas no motel

header Parameters
TOKEN
required
string <uuid>
SOFTHOUSE
required
string <uuid>

Responses

200

Sucesso

401

Acesso não permitido

get /coupons
https://api.sismotel.com.br/coupons

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "success": true,
  • "result":
    [
    ]
}

Retorna os dados de um cupom de desconto pelo código.

Recupera todas as informações de um cupom de desconto.

path Parameters
code
required
integer

Código do cupom de desconto, retornado quando foi criado.

header Parameters
TOKEN
required
string <uuid>
SOFTHOUSE
required
string <uuid>

Responses

200

Sucesso

401

Acesso não permitido

get /coupon/{code}
https://api.sismotel.com.br/coupon/{code}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "success": true,
  • "result":
    [
    ]
}

(APENAS PARA O SISMOTEL) Informa que o cupom de desconto foi usado.

Atualiza o cupom de desconto, informando que o código do cupom já foi usado no motel.

path Parameters
code
required
integer

Código do cupom de desconto, retornado quando foi criado.

suites_id
required
integer

Código da suíte usada.

sales_id
required
integer

Código da venda usada.

header Parameters
TOKEN
required
string <uuid>
SOFTHOUSE
required
string <uuid>

Responses

200

Sucesso

401

Acesso não permitido

put /coupon/{code}
https://api.sismotel.com.br/coupon/{code}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "success": true,
  • "result":
    {
    }
}

Cancela um cupom de desconto

Cancela o cupom de desconto informado

path Parameters
code
required
integer

Código do cupom de desconto, retornado quando foi criado.

header Parameters
TOKEN
required
string <uuid>
SOFTHOUSE
required
string <uuid>

Responses

200

Sucesso, pode retornar success true ou false. Apenas um desses dois, o exemplo exibe as duas opções.

400

Falha na operação de cancelar o cupom de desconto

401

Acesso não permitido

delete /coupon/{code}
https://api.sismotel.com.br/coupon/{code}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    },
  • {
    }
]

Cria um cupom de desconto.

Cria um cupom de desconto.

header Parameters
TOKEN
required
string <uuid>
SOFTHOUSE
required
string <uuid>
Request Body schema: application/json

Exemplo de criação de um cupom de desconto.

categories_id
string

Uma string com ids das categorias que serão válidas para o cupom, separadas com vírgulas.

start_date
string

Data de início do cupom

end_date
string

Data de expiração do cupom

value
number >= 1

Valor do Cupom

code
string <= 8 characters

Código do cupom de desconto (Se não informar, será gerado um código)

type
string

Tipo de valor no cupom, P - Porcentagem; R - Reais

cpf
string

CPF válido do Cliente

email
string <= 128 characters

Email válido do Cliente

description
string <= 255 characters

Descrição (opcional)

Responses

200

Sucesso, pode retornar success true ou false. Apenas um desses dois, o exemplo exibe as duas opções.

400

Erro na validação de parâmetros

401

Acesso não permitido

post /coupon
https://api.sismotel.com.br/coupon

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "categories_id": "1, 2, 3",
  • "start_date": "2020-03-20",
  • "end_date": "2020-04-20",
  • "value": 0,
  • "code": "<CODIGO>",
  • "type": "R",
  • "cpf": "<CPF VÁLIDO>",
  • "email": "<EMAIL VÁLIDO>",
  • "description": null
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    },
  • {
    }
]

Categorias

Busca as categorias.

Recupera as categorias do motel

header Parameters
TOKEN
required
string <uuid>
SOFTHOUSE
required
string <uuid>

Responses

200

Sucesso

401

Acesso não permitido

get /categories
https://api.sismotel.com.br/categories

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "success": true,
  • "result":
    [
    ]
}