2 - Geral

2.0 - Conceituação

Esta seção reúne os endpoints de uso geral da aplicação, responsáveis por disponibilizar informações institucionais, configurações visuais, parâmetros operacionais e recursos auxiliares necessários para o funcionamento e personalização da plataforma.

2.1 - Consulta a estrutura de layout

[GET] /api/v1/application/layout

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Authentication}	Sim	Bearer

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Sucesso na consulta	Boolean
code	Código de sucesso	Number
application	Dados da aplicação	Object
application.id	ID da aplicação	String
application.name	Nome da aplicação	String
application.contact_phone	Telefone de contato	String
application.email	E-mail da aplicação	String
application.document	Documento da aplicação	String
application.logo	Logo da aplicação	String
application.favicon	Favicon da aplicação	String
layout	Informações sobre o layout	Object
layout.app_strings	Informações sobre o layout	Object
layout.app_strings.client_name	Informações sobre o layout	String
layout.app_colors	Informações sobre o layout	Object
layout.app_colors.primary_01	Informações sobre o layout	String
layout.app_colors.primary_02	Informações sobre o layout	String
layout.app_colors.primary_03	Informações sobre o layout	String
layout.app_colors.secondary_01	Informações sobre o layout	String
layout.app_colors.secondary_02	Informações sobre o layout	String
layout.app_colors.secondary_03	Informações sobre o layout	String
layout.app_colors.secondary_04	Informações sobre o layout	String
layout.app_colors.secondary_05	Informações sobre o layout	String
layout.app_colors.secondary_06	Informações sobre o layout	String
layout.app_colors.neutral_01	Informações sobre o layout	String
layout.app_colors.neutral_02	Informações sobre o layout	String
layout.app_colors.neutral_03	Informações sobre o layout	String
layout.app_colors.neutral_04	Informações sobre o layout	String
layout.app_colors.neutral_05	Informações sobre o layout	String
layout.app_colors.neutral_06	Informações sobre o layout	String
layout.app_colors.neutral_07	Informações sobre o layout	String
layout.app_colors.negative	Informações sobre o layout	String
layout.app_colors.positive	Informações sobre o layout	String
layout.app_gradients	Informações sobre o layout	Object
layout.app_gradients.gradient_01_colors_01	Informações sobre o layout	String
layout.app_gradients.gradient_01_colors_02	Informações sobre o layout	String
layout.app_gradients.gradient_01_angle	Informações sobre o layout	Number
layout.app_gradients.gradient_02_colors_01	Informações sobre o layout	String
layout.app_gradients.gradient_02_colors_02	Informações sobre o layout	String
layout.app_gradients.gradient_02_angle	Informações sobre o layout	Number
layout.app_gradients.linear_02_colors_01	Informações sobre o layout	String
layout.app_gradients.linear_02_colors_02	Informações sobre o layout	String
layout.app_gradients.linear_02_angle	Informações sobre o layout	Number
layout.app_gradients.card_gradient_colors_01	Informações sobre o layout	String
layout.app_gradients.card_gradient_colors_02	Informações sobre o layout	String
layout.app_gradients.card_gradient_angle	Informações sobre o layout	Number
layout.app_images	Informações sobre o layout	Object
layout.app_images.logo	Informações sobre o layout	String
layout.app_images.logo_white	Informações sobre o layout	String
layout.app_images.logo_bw	Informações sobre o layout	String
layout.app_images.logo_minimal	Informações sobre o layout	String
layout.app_images.logo_minimal_white	Informações sobre o layout	String
layout.app_images.login_background	Informações sobre o layout	String
layout.app_images.credit_card	Informações sobre o layout	String
layout.app_images.pix_keys_onboarding	Informações sobre o layout	String
layout.app_images.pix_places_withdrawl	Informações sobre o layout	String
layout.app_images.onboarding_start	Informações sobre o layout	String

{
    "success": "true",
    "code": "200",
    "application": {
        "id": "59fac7a3-df60-47ca-9855-1c365eac7e54",
        "name": "Cronos whitelabel",
        "contact_phone": "99999999999",
        "email": "cronos@example.com",
        "document": "12345678000190",
        "logo": "http://cronos/public/logo-acesso.png",
        "favicon": "http://cronos/public/cronos_favicon.png"
    },
    "layout": {
        "app_strings": {
            "client_name": "Cronos Bank"
        },
        "app_colors": {
            "primary_01": "#20A096",
            "primary_02": "#0096D9",
            "primary_03": "#FFFFFF",
            "secondary_01": "#A0A6BD",
            "secondary_02": "#93A4BF",
            "secondary_03": "#3F4171",
            "secondary_04": "#171725",
            "secondary_05": "#EFFFE7",
            "secondary_06": "#EEF6FF",
            "neutral_01": "#F6F6F8",
            "neutral_02": "#F2F2F2",
            "neutral_03": "#DDDDDD",
            "neutral_04": "#B7B7B7",
            "neutral_05": "#909090",
            "neutral_06": "#1D1D1D",
            "neutral_07": "#000000",
            "negative": "#F03D3E",
            "positive": "#00A900"
        },
        "app_gradients": {
            "gradient_01_colors_01": "#0096D9",
            "gradient_01_colors_02": "#20A096",
            "gradient_01_angle": "90",
            "gradient_02_colors_01": "#20A096",
            "gradient_02_colors_02": "#0096D9",
            "gradient_02_angle": "70",
            "linear_02_colors_01": "#D9D9D9",
            "linear_02_colors_02": "#F2F2F2",
            "linear_02_angle": "127",
            "card_gradient_colors_01": "#20A096",
            "card_gradient_colors_02": "#0096D9",
            "card_gradient_angle": "90"
        },
        "app_images": {
            "logo": "logo.png",
            "logo_white": "logo_white.png",
            "logo_bw": "logo_bw.png",
            "logo_minimal": "logo_minimal.png",
            "logo_minimal_white": "logo_minimal_bw.png",
            "login_background": "login_background.png",
            "credit_card": "credit_card.png",
            "pix_keys_onboarding": "pix_keys_onboarding.png",
            "pix_places_withdrawl": "pix_places_withdrawl.png",
            "onboarding_start": "onboarding_start.png"
        }
    }
}

2.2 - Consulta a estrutura de settings

[GET] /api/v1/application/settings

[HEADER]

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Authentication}	Sim	Bearer

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Sucesso na consulta	Boolean
code	Código de sucesso	Number
application	Dados da aplicação	Object
application.id	ID da aplicação	String
application.name	Nome da aplicação	String
application.contact_phone	Telefone de contato	String
application.email	E-mail da aplicação	String
application.document	Documento da aplicação	String
application.logo	URL da logo da aplicação	String
application.favicon	URL do favicon da aplicação	String
layout	Configurações de layout	Object
layout.color_primary	Cor primária da aplicação	String
layout.color_secondary	Cor secundária da aplicação	String
layout.balance_enabled	Exibição de saldo habilitada	String

{
    "success": "true",
    "code": "200",
    "application": {
        "id": "59fac7a3-df60-47ca-9855-1c365eac7e54",
        "name": "Cronos whitelabel",
        "contact_phone": "99999999999",
        "email": "cronos@example.com",
        "document": "12345678000190",
        "logo": "http://cronos/public/logo-acesso.png",
        "favicon": "http://cronos/public/cronos_favicon.png"
    },
    "layout": {
        "color_primary": "",
        "color_secondary": "",
        "balance_enabled": ""
    }
}

2.3 - Verificar status do sistema

A partir deste endpoint é possível verificar o status do sistema

[GET] /api/v1/application/health

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
bridge	Status bridge	Boolean
database	Status database	Boolean

{
    "bridge": "true",
    "database": "true"
}

2.4 - Lista de bancos

[GET] /api/v1/banks/list

[HEADER]

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[PAYLOAD]

Propriedade	Descrição	Obrigatório	Tipo
search (QueryParam)	nome	Não	String
direction (QueryParam)	direção(desc, asc)	Não	String
order_by (QueryParam)	ordenar por	Não	String

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Sucesso na consulta	Boolean
code	Código de sucesso	Number
banks	Lista de bancos	Array
banks.[].code	Código do banco	Number
banks.[].name	Nome do banco	String

{
    "success": "true",
    "code": "200",
    "banks": [
        {
            "code": "000",
            "name": "Banco ..."
        }
    ]
}

2.5 - Consulta Politica de privacidade

[GET] /api/v1/privacypolicy

[HEADER]

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Authentication}	Sim	Bearer

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Sucesso na consulta	Boolean
code	Código de sucesso	Number
application	Dados da whitelabel	Object
application.id	ID da whitelabel	String
application.name	Nome da whitelabel	Number
privacy_policy	Termo de Política e Privacidade	String

{
    "success": "true",
    "code": "200",
    "application": {
        "id": "4332ada7-60bf-42a3-9f51-69f2f64d593f",
        "name": "Cronos"
    },
    "privacy_policy": "Termo ...."
}