Cindie :: Integração para ambientes gerenciados

Coleção de APIs para integração do app Cindie em ambientes gerenciados. Exemplo: SmartTV e TV Box para hotelaria.

Fluxo

cindie-ambiente-gerenciado-diagrama1.jpg

Ativação de dispositivo

 

A API RESTfull abaixo é indicada para receber dados de ativação de um novo ponto de acesso ao app Cindie.

Endpoint

[URL]/produto/{idpc}/cindie

As informações para início dos destes em ambiente staging (URL e idpc) serão fornecidas ao responsável pela integração.

Authorization

FIELD TYPE REQUIRED DESCRIPTION
Authorization String YES Bearer Token

O Bearer Token será fornecido ao responsável pela integração.

POST

Request data

FIELD TYPE REQUIRED DESCRIPTION
tvid string YES Identificação única do ponto de acesso

Response data

KEY TYPE DESCRIÇÃO
success boolean

True: usuário criado

False: erro na criação do usuário
data string URL com token do usuário
errors array JSON OBJECT - ERRORS
 JSON OBJECT - ERRORS 
FIELD TYPE DESCRIPTION
code String Código de erro gerado pelo sistema
message String Mensagem com a descrição do erro

Examples

Request

{
  "tvid": "EgZjaHJvbWUyBggAEEUYOTIMCAEQABgUGIcCGIAEMgoI"
}

A chave tvid deve ter como valor o dado que identifica o dispositivo que está acessando. Por exemplo, o número de série do fabricante, o MAC address ou a identificação do dispositivo no domínio. Alternativamente, pode ser utilizada a identificação física de onde o dispositivo está instalado (leito12, quarto402 etc.). Contudo, em caso de mudança de localização, é recomendada a reconfiguração do tvid desse dispositivo movimentado.

Response

HTTP 201 OK

{
    "success": true,
    "data": "https://cindie.com/#!/user-token/MTAwMi1jbnk4zckAxNzYwMTE0NDExLjA1MTM0MkNpbmRpRQ",
    "errors": null
}

Response

HTTP 400 BAD REQUEST

{
    "success": false,
    "data": null,
    "errors": {
        "code": null,
        "message": "Parâmetros inválidos!"
    }
}

O tempo de execução da API na primeira ativação do ponto de acesso pode superar 5 segundos. Recomendamos que o tempo de espera pela resposta tenha tolerância mínima de 10 segundos. Após a primeira ativação, o tempo de resposta será inferior a 1 segundo.

Recomendamos que o processo de ativação para SmartTV e TV Box seja feito por implantação massiva prévia. Favor consultar o Analista de Integração responsável pelo seu projeto para informações a respeito desse processo.