API Criação de Clientes

Endpoint para criação de clientes (Tribo Jornada)

As funcionalidades listadas abaixo devem ser acessada através dos seguintes endereços:

Homologação: https://homologacao.blu.com.br/api

• O ambiente de teste encontra-se no seguinte endereço: https://homologacao.blu.com.br

Produção: https://portal.blu.com.br/api

#ATENÇÃO! Para o uso da funcionalidade é necessário que entre em contato com a Blu para criação do usuário e senha para integração

Endpoint para Login

POST /users/login

Headers

Name	Type	Description
Accept*	String	version=1
Content-Type	String	application/json

Request Body

Name	Type	Description
user*	Object	Objeto que contém o e-mail e senha do usuário
email*	String	E-mail do usuário
password*	String	Senha do usuário

422: Unprocessable Entity Falha ao logar

{
  "message": "Não foi possível encontrar o usuário com o email e senha informados."
}

200: OK Login efetuado com sucesso

{
  "authentication_token": "eyJhbGciOiJIUzI1NiJ.eyJpZCI6MTQsImVtYWlsIjoidXNlckBwYWcubmV0IiwiZXhwIjoxNjM2NTY3NjA5LCJyZWZyZXNoYWJsZSI6dHJ1ZX0.6z91o45IkOUTbXX21eeuTYeojs68g_Sn1paboys4Vl8",
  "message": "Usuário encontrado com sucesso.",
  "user_id": 1,
  "user_name": "Empresa LTDA"
}

Endpoint para Cadastro de clientes

POST /automatic_registrations/clients

O token descrito abaixo deve ser obtido através do endpoint de login, campo authentication_token

Headers

Name	Type	Description
Accept*	String	version=1
Authorization*	String	Token token={token}
Content-Type*	String	application/json

Request Body

Name	Type	Description
cpf*	String	CPF do usuário
email*	String	E-mail do usuário
phone*	String	Telefone com DDD do usuário
name*	String	Nome completo do usuário
cnpj*	String	CNPJ da empresa
department_name*	String	Departamento da empresa, valores permitidos: Móveis, Móveis Planejados Vestuário Alimentos e Bebidas Artigos de Defesa e Segurança Colchões Eletroeletrônico Óticas Calçados Eventos Outros
company*	Object	Objeto contendo os dados da empresa
user*	Object	Objeto contendo os dados do usuário
project_name	String	Parâmetro opcional usado para integrações pontuais, deve ser consultada diretamente com o time de desenvolvimento
ecommerce_gateway	Boolean	Parâmetro opcional usado para integrações pontuais, deve ser consultada diretamente com o time de desenvolvimento

201: Created Cliente criado com sucesso

{
  "message": "Cliente criado com sucesso",
  "client_id": 1,
  "user_id": 1
}

422: Unprocessable Entity Falha na validação dos dados

{
  "status": "422 - Unprocessable entity",
  "summary": "Não foi possível realizar esta operação. Para mais informações, entre em contato com o suporte por um de nossos canais de atendimento.",
  "message": "Algo deu errado. Por favor, tente novamente.",
  "details": [
    {
      "id": "user",
      "messages": [
        {
          "cpf": [
            "já existe usuario com esse cpf"
          ],
          "email": [
            "já existe usuario com esse email"
          ],
          "phone": [
            "já existe usuario com esse phone"
          ]
        }
      ]
    },
    {
      "id": "company",
      "messages": [
        {
          "department_name": [
            "não existe"
          ],
          "cnpj": [
            "já existe cliente com esse cnpj"
          ]
        }
      ]
    }
  ]
}

Endpoint para Cadastro de clientes

GET /automatic_registrations/clients/:client_id

O token descrito abaixo deve ser obtido através do endpoint de login, campo authentication_token

Headers

Name	Type	Description
Accept*	String	version=1
Authorization*	String	Token token={token}
Content-Type*	String	application/json

200: OK Cliente criado com sucesso

{
  "id": 515,
  "uuid": "6e604d74",
  "name": "company name",
  "business_name": "company name",
  "cpf_cnpj": "10724527000112",
  "department_name": "Móveis",
  "automatic_registration_status": "waiting_first_login",
  "merchant_token": "mk_swt5EROPkUOGFoduw8dg",
  "created_at": "2022-02-18T10:50:02.047-03:00",
  "updated_at": "2022-02-18T11:07:47.590-03:00",
  "tracking": {
    "id": 13,
    "utm_source": "anonymous"
  },
  "users": [
    {
      "id": 45,
      "name": "user name",
      "email": "[e-mail]",
      "phone": "11976673736",
      "phone_2": null,
      "phone_3": null
    }
  ]
}

Endpoint para validação

POST /automatic_registrations/clients/validate

Pode ser usado apenas para validar as informações antes de chamar o endpoint de criação, a forma de uso quanto aos dados e estrutura de envio é o mesmo do endpoint de criação, com a distinção apenas da resposta no caso de todos dados validos

422: Unprocessable Entity Falha na validação dos dados

{
  "status": "422 - Unprocessable entity",
  "summary": "Não foi possível realizar esta operação. Para mais informações, entre em contato com o suporte por um de nossos canais de atendimento.",
  "message": "Algo deu errado. Por favor, tente novamente.",
  "details": [
    {
      "id": "user",
      "messages": [
        {
          "cpf": [
            "já existe usuario com esse cpf"
          ],
          "email": [
            "já existe usuario com esse email"
          ],
          "phone": [
            "já existe usuario com esse phone"
          ]
        }
      ]
    },
    {
      "id": "company",
      "messages": [
        {
          "department_name": [
            "não existe"
          ],
          "cnpj": [
            "já existe cliente com esse cnpj"
          ]
        }
      ]
    }
  ]
}

200: OK Dados validos

{ "message": "Cliente e usuário válidos" }

Exemplos de Chamadas

Endpoint de Login

{
  "user": {
    "email": "[e-mail]",
    "password": "senha123"
  }
}

Endpoint de Criação de clientes

{
  "client": {
    "project_name": "nome_projeto",
    "user": {
      "cpf": "43542760030",
      "email": "[e-mail]",
      "phone": "11977227583",
      "name": "Emanuel Silva"
    },
    "company": {
      "cnpj": "95186094000141",
      "department_name": "Outros",
      "declared_department_name": "",
      "ecommerce_gateway": true
    }
  }
}

Endpoint de validação de dados

{
  "client": {
    "user": {
      "cpf": "43542760030",
      "email": "[e-mail]",
      "phone": "11977227583",
      "name": "Emanuel Silva"
    },
    "company": {
      "cnpj": "95186094000141",
      "department_name": "Outros",
      "declared_department_name": ""
    }
  }
}