Apps e credenciais

Esta página apresenta o fluxo necessário para autenticar um usuário, identificar sua conta, criar uma aplicação e gerar as credenciais que serão utilizadas pelos serviços da TechTrue®.

Dica

Execute as etapas na ordem apresentada. O accountId retornado na consulta do usuário atual é necessário para criar o app, e o appId retornado na criação do app é necessário para gerar a credencial.

Utilize https://api.techtrue.com.br como URL base. Nos exemplos, substitua os valores entre {{ }} pelos dados do seu ambiente.

Realizar login

Autentica o usuário e retorna o token utilizado nas próximas requisições.

shell

curl "https://api.techtrue.com.br/api/v1/auth/login" \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"user":"usuario@empresa.com.br","password":"{{senha}}"}'

node.js

const axios = require('axios');

const response = await axios.post(
  'https://api.techtrue.com.br/api/v1/auth/login',
  {
    user: 'usuario@empresa.com.br',
    password: '{{senha}}'
  },
  {
    headers: { 'Content-Type': 'application/json' }
  }
);

console.log(response.data);

HTTP Request

POST /api/v1/auth/login

Body Parameters

Name	Located in	Description	Required	Type
user	body	E-mail do usuário	yes	string
password	body	Senha do usuário	yes	string

Nota

Guarde o token retornado pelo login e envie-o no cabeçalho Authorization: Bearer {{token}} das demais requisições desta página.

Consultar o usuário atual

Retorna a conta associada ao usuário autenticado. O campo id da resposta será utilizado como accountId na criação do app.

shell

curl "https://api.techtrue.com.br/api/v1/accounts/user" \
  -H "Authorization: Bearer {{token}}"

node.js

const axios = require('axios');

const response = await axios.get(
  'https://api.techtrue.com.br/api/v1/accounts/user',
  {
    headers: { Authorization: 'Bearer {{token}}' }
  }
);

console.log(response.data);

Exemplo de resposta:

{
  "id": "{{accountId}}",
  "name": "{{nome_da_conta}}",
  "active": true,
  "owner": {
    "id": "{{ownerId}}"
  }
}

HTTP Request

GET /api/v1/accounts/user

HTTP Response

Code	Description
200	OK
401	Unauthorized

Criar um app

Cria uma aplicação vinculada à conta do usuário. Utilize no campo accountId o identificador obtido na etapa anterior.

shell

curl "https://api.techtrue.com.br/api/v1/apps" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {{token}}" \
  -d '{"name":"App Teste Cliente","description":"Nome Cliente","accountId":"{{accountId}}"}'

node.js

const axios = require('axios');

const response = await axios.post(
  'https://api.techtrue.com.br/api/v1/apps',
  {
    name: 'App Teste Cliente',
    description: 'Nome Cliente',
    accountId: '{{accountId}}'
  },
  {
    headers: {
      'Content-Type': 'application/json',
      Authorization: 'Bearer {{token}}'
    }
  }
);

console.log(response.data);

HTTP Request

POST /api/v1/apps

Body Parameters

Name	Located in	Description	Required	Type
name	body	Nome da aplicação	yes	string
description	body	Descrição da aplicação	yes	string
accountId	body	Identificador da conta	yes	UUID

Nota

Guarde o identificador do app criado. Ele será utilizado como appId na próxima etapa.

Criar uma credencial

Gera uma credencial para o app informado.

shell

curl "https://api.techtrue.com.br/api/v1/app-credentials" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {{token}}" \
  -d '{"appId":"{{appId}}"}'

node.js

const axios = require('axios');

const response = await axios.post(
  'https://api.techtrue.com.br/api/v1/app-credentials',
  { appId: '{{appId}}' },
  {
    headers: {
      'Content-Type': 'application/json',
      Authorization: 'Bearer {{token}}'
    }
  }
);

console.log(response.data);

HTTP Request

POST /api/v1/app-credentials

Body Parameters

Name	Located in	Description	Required	Type
appId	body	Identificador do app	yes	UUID

Cuidado

Armazene a chave e o segredo retornados em local seguro. Não publique credenciais em código-fonte, prints, arquivos versionados ou ferramentas de comunicação.

As credenciais geradas podem ser validadas e trocadas por um token conforme descrito na página Autenticação.