Autenticação on Documentação Orus

0 - Autenticação Aplicação

Thu, 12 Sep 2024 17:05:12 +0000

1.0 - Autenticação de aplicação

[GET] /api/v1/application/token

Propriedade	Valor
Authorization	Basic Auth({public_key}:{private_key})

[RESPONSES]

Código	Descrição
200	Autenticação bem sucedida
403	Falha na autenticação

Propriedade	Descrição	Tipo
success	Sucesso - True	Boolean
code	Código de sucesso	Number
token	Token gerado da whitelabel	Object
application	Dados da whitelabel	Object
application.id	Id	String
application.name	Nome	String
application.contact_phone	Contato	String
application.email	Email	String
application.document	Número do documento	String
application.logo	Link da imagem da logo	String
application.favicon	Link da imagem do favicon	String
settings	Configurações	Object
settings.color_primary	Especificações configurações	String
settings.color_secondary	Especificações configurações	String
settings.balance_enabled	Especificações configurações	String
layout	Dados do layout	Object
layout.app_strings	Especificações layout	Object
layout.app_strings.client_name	Especificações layout	String
layout.app_colors	Especificações layout	Object
layout.app_colors.primary_01	Especificações layout	String
layout.app_colors.primary_02	Especificações layout	String
layout.app_colors.primary_03	Especificações layout	String
layout.app_colors.secondary_01	Especificações layout	String
layout.app_colors.secondary_02	Especificações layout	String
layout.app_colors.secondary_03	Especificações layout	String
layout.app_colors.secondary_04	Especificações layout	String
layout.app_colors.secondary_05	Especificações layout	String
layout.app_colors.secondary_06	Especificações layout	String
layout.app_colors.neutral_01	Especificações layout	String
layout.app_colors.neutral_02	Especificações layout	String
layout.app_colors.neutral_03	Especificações layout	String
layout.app_colors.neutral_04	Especificações layout	String
layout.app_colors.neutral_05	Especificações layout	String
layout.app_colors.neutral_06	Especificações layout	String
layout.app_colors.neutral_07	Especificações layout	String
layout.app_colors.negative	Especificações layout	String
layout.app_colors.positive	Especificações layout	String
layout.app_gradients	Especificações layout	Object
layout.app_gradients.gradient_01_colors_01	Especificações layout	String
layout.app_gradients.gradient_01_colors_02	Especificações layout	String
layout.app_gradients.gradient_01_angle	Especificações layout	Number
layout.app_gradients.gradient_02_colors_01	Especificações layout	String
layout.app_gradients.gradient_02_colors_02	Especificações layout	String
layout.app_gradients.gradient_02_angle	Especificações layout	Number
layout.app_gradients.linear_02_colors_01	Especificações layout	String
layout.app_gradients.linear_02_colors_02	Especificações layout	String
layout.app_gradients.linear_02_angle	Especificações layout	Number
layout.app_gradients.card_gradient_colors_01	Especificações layout	String
layout.app_gradients.card_gradient_colors_02	Especificações layout	String
layout.app_gradients.card_gradient_angle	Especificações layout	Number
layout.app_images	Especificações layout	Object
layout.app_images.logo	Especificações layout	String
layout.app_images.logo_white	Especificações layout	String
layout.app_images.logo_bw	Especificações layout	String
layout.app_images.logo_minimal	Especificações layout	String
layout.app_images.logo_minimal_white	Especificações layout	String
layout.app_images.login_background	Especificações layout	String
layout.app_images.credit_card	Especificações layout	String
layout.app_images.pix_keys_onboarding	Especificações layout	String
layout.app_images.pix_places_withdrawl	Especificações layout	String
layout.app_images.onboarding_start	Especificações layout	String

{
 "success": "true",
 "code": "200",
 "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiI.....",
 "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"
 },
 "settings": {
 "color_primary": "",
 "color_secondary": "",
 "balance_enabled": ""
 },
 "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"
 }
 }
}

Propriedade	Descrição	Tipo
success	Booleano que identifica o sucesso ou não da autenticação.	Boolean
message	Mensagem de retorno sobre a consulta.	String
code	Código do erro	Inteiro

{
 "success":false,
 "message": "Unauthorized",
 "code":403
 
}

1 - Autenticação Usuário

Thu, 12 Sep 2024 17:05:12 +0000

1.0 - Autenticação do customer via documento e senha

Para realizar a autenticação de customer, é necessário que o mesmo esteja aprovado na base; utilizará o documento e a senha que foi cadastrada para autenticação

O token gerado no response é utilizado nos Authorization para que seja realizadas transações Cash_in e Cash_out.

[POST] /api/v1/user/auth

[Parâmetros]

Propriedade	Valor
Authorization	Bearer {Token whitelabel}

[PAYLOAD]

Propriedade	Descrição	Obrigatório	Condição	Tipo
document	Documento CPF/CNPJ	Sim		String
password	Senha do Customer	Sim		String

[RESPONSES]

Código	Descrição
200	Autenticação gerada com sucesso
500	Falha na autenticação

Propriedade	Descrição	Tipo
full_name	Nome completo	String
email	Email	String
document	CPF/CNPJ	String
birth_date	Data de nascimento	String
token	Token de acesso	Object
address	Informações do endereço	Object
address.postal_code	CEP	String
address.country	País	String
address.state	Estado	String
address.neighborhood	Bairro	String
address.city	Cidade	String
address.street	Rua	String
address.number	Número	String
phone	Informações do telefone	Object
phone.phone_prefix	Prefixo	String
phone.phone_number	Número	String
account_id	Informações da conta	String
username	Informações da conta	String
qrcode	Informações da conta	String
avatar_url	Informações da conta	String
logo_url	Informações da conta	String
card	Informações da conta	Object
card.id	Informações da conta	String
card.defaut	Informações da conta	String
card.deleted	Informações da conta	String
card.token_id	Informações da conta	String
card.card_id	Informações da conta	String
card.user_id	Informações da conta	String
card.brand	Informações da conta	String
card.brand_cover	Informações da conta	String
card.holder_name	Informações da conta	String
card.expiration_month	Informações da conta	String
card.expiration_year	Informações da conta	String
card.first4_digits	Informações da conta	String
card.created_at	Informações da conta	String
card.updated_at	Informações da conta	String
card.last4_digits	Informações da conta	String
card.error_message	Informações da conta	String
success	Sucesso na consulta	Boolean
code	Código de sucesso	String
individual_id	ID do customer	String
steps	Documentação pendente	Array
status	Status da conta	String
status_label	Descrição do status	String
bank_account	Informações da conta bancária	Object
bank_account.type_b_account	Tipo de conta	String
bank_account.bank_code	Código do banco	String
bank_account.bank_name	Nome do banco	String
bank_account.agency	Agência	String
bank_account.account_number	Número da conta	String
bank_account.account_digit	Dígito	String

{
 "full_name": "Fulano da Silva",
 "email": "fulnano@example.com",
 "document": "12345678910",
 "birth_date": "17/10/2002",
 "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiI.....",
 "address": {
 "postal_code": "12345678",
 "country": "Brasil",
 "state": "SP",
 "neighborhood": "Jd. Hyorashi",
 "city": "Presidente Prudente",
 "street": "Gyuski tashyran",
 "number": "190"
 },
 "phone": {
 "phone_prefix": "99",
 "phone_number": "999999999"
 },
 "account_id": "123456",
 "username": "",
 "qrcode": "",
 "avatar_url": "http://cronos/storage/default_images/default-avatar.jpg",
 "logo_url": "http://cronos/public/logo-acesso.png",
 "card": {
 "id": "0",
 "defaut": 0,
 "deleted": "",
 "token_id": "",
 "card_id": "",
 "user_id": "",
 "brand": "",
 "brand_cover": "",
 "holder_name": "",
 "expiration_month": "",
 "expiration_year": "",
 "first4_digits": "",
 "created_at": "",
 "updated_at": "",
 "last4_digits": "",
 "error_message": ""
 },
 "success": true,
 "code": 200,
 "individual_id": "09ed27ea-f1d2-4176-bbc4-e60b40cb1e1f",
 "steps": [
 ""
 ],
 "status": "ativa",
 "status_label": "ativo",
 "bank_account": {
 "type_b_account": "CC",
 "bank_code": "000",
 "bank_name": "Cronos",
 "agency": "0001",
 "account_number": "123456",
 "account_digit": 0
 }
}

Propriedade	Descrição	Obrigatório	Tipo
success	Booleano que identifica o sucesso ou não da autenticação.	Sim	Boolean
code	Código de sucesso	Sim	String
message	Message que descreve o motivo da falha	Sim	String

{
 "success": false,
 "message": "Unauthorized",
 "code": 500
}

Autenticação on Documentação Orus

0 - Autenticação Aplicação

1.0 - Autenticação de aplicação

[HEADER]

[RESPONSES]

1 - Autenticação Usuário

1.0 - Autenticação do customer via documento e senha

[Parâmetros]

[HEADER]

[PAYLOAD]

[RESPONSES]