Autenticação e aplicativos · Aplicativos

Aplicativos da pessoa, usuários, grupos de permissão e convites

RESThttps://app.omie.com.br/api/portal

4consultas

1alteração

RESTformato

ConsultarAplicativo

consulta

Detalhes de um aplicativo

GET/api/portal/apps/{appHash}/Authorization: Bearer com o token de usuário

Os dados de um aplicativo a que o usuário tem acesso: situação, contrato, papel do usuário e api_access.

Obrigatórios 1

Campo	Tipo	Descrição
`appHash`	texto	No caminho. Hash do aplicativo

Retorno 16O que volta numa chamada bem-sucedida

Campo	Tipo	Descrição
`active`	sim/não	Identifica se o aplicativo está ativoEx.: `true`
`admin_role`	sim/não	Identifica se o usuário atual é administrador do aplicativoEx.: `true`
`api_access`	texto	O que o aplicativo precisa para consumir a API, a mesma classificação do gate de API: TRIAL (demonstração, cota por dia), FREE (plano gratuito, cota por dia), SANDBOX, ALLOWED (addon que libera a API), BLOCKED (precisa de addon na Omie Store) ou null (fora do controle por addon).Valores: `TRIAL`, `FREE`, `SANDBOX`, `ALLOWED`, `BLOCKED`, `null`
`app_hash`	texto	Hash de identificação do aplicativoEx.: `wonka-07djm8`
`app_type`	texto	Tipo do aplicativoEx.: `OMIE`Valores: `OMIE`, `ONEFLOW`
`company_icon`	texto	URL do icone do aplicativoEx.: `https://static.omie.com.br/exemplo/icone.png`
`company_logo`	texto	URL do logotipo do aplicativoEx.: `https://static.omie.com.br/exemplo/logo.png`
`company_nicename`	texto	Ex.: `Wonka - A Fantástica Fábrica`
`contract`	objeto
`contract.contract_id`	número inteiro	ID do tipo de contratoEx.: `13`
`contract.contract_identifier`	texto	Código do contratoEx.: `V6.003`
`contract.contract_label`	texto	Nome amigável do contratoEx.: `Omie.Fit`
`contract.contract_name`	texto	Nome do contratoEx.: `V6`
`evaluation_date`	texto	Data de expiração do aplicativo trialEx.: `2015-02-06T10:44:37-0300`
`is_demo`	sim/não	Identifica se é um aplicativo de demonstraçãoEx.: `true`
`is_pinned`	sim/não	Identifica se o aplicativo está favoritadoEx.: `true`
`online_training_enabled`	sim/não	Identifica se o aplicativo possui consultoria habilitadaEx.: `true`
`purchase_date`	texto	Data que o aplicativo foi assinadoEx.: `2015-02-06T10:44:37-0300`
`purchase_url`	texto	Se é um aplicativo de demonstração, teremos a URL do carrinho de compras
`service_status`	texto	Identifica o status do aplicativoValores: `ACTIVE`, `PENDING`, `ARCHIVED`, `CANCELLED`

GET /api/portal/apps/{appHash}/

APP_HASH='empresa-abc123'
curl -s -X GET "https://app.omie.com.br/api/portal/apps/${APP_HASH}/" \
  -H "Authorization: Bearer $TOKEN_DE_USUARIO"

import os
import requests

app_hash = "empresa-abc123"

resp = requests.request(
    "GET",
    f"https://app.omie.com.br/api/portal/apps/{app_hash}/",
    headers={"Authorization": f"Bearer {os.environ['TOKEN_DE_USUARIO']}"},
    timeout=60,
)
print(resp.json())

const appHash = "empresa-abc123";

const resp = await fetch(`https://app.omie.com.br/api/portal/apps/${appHash}/`, {
  method: "GET",
  headers: {
    "Authorization": `Bearer ${process.env.TOKEN_DE_USUARIO}`,
  },
});
console.log(await resp.json());

<?php
$appHash = 'empresa-abc123';
$ch = curl_init("https://app.omie.com.br/api/portal/apps/{$appHash}/");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("TOKEN_DE_USUARIO"),
    ],
]);
echo curl_exec($ch);

require "net/http"

app_hash = 'empresa-abc123'
uri = URI("https://app.omie.com.br/api/portal/apps/#{app_hash}/")
pedido = Net::HTTP::Get.new(uri)
pedido["Authorization"] = "Bearer #{ENV.fetch('TOKEN_DE_USUARIO')}"
resp = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(pedido) }
puts resp.body

import java.net.URI;
import java.net.http.*;

var appHash = "empresa-abc123";
var pedido = HttpRequest.newBuilder()
    .uri(URI.create("https://app.omie.com.br/api/portal/apps/" + appHash + "/"))
    .header("Authorization", "Bearer " + System.getenv("TOKEN_DE_USUARIO"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());

// TokenDeUsuario: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
    Resposta = Web.Contents(
        "https://app.omie.com.br/api/portal/apps/empresa-abc123/",
        [
            Headers = [Authorization = "Bearer " & TokenDeUsuario]
        ]
    ),
    Dados = Json.Document(Resposta)
in
    Dados

ConvidarUsuario

altera dados

Convida uma pessoa para o aplicativo

POST/api/portal/apps/{appHash}/invite/Authorization: Bearer com o token de usuário

Convida um e-mail para o aplicativo, num grupo de permissão, e manda o e-mail de convite em nome de quem está autenticado. Só para quem administra o aplicativo, com o aplicativo ativo ou suspenso. Aplicativo com login por SSO só aceita e-mail do domínio da empresa. A resposta de erro vem com status ERROR e o motivo em description.

Obrigatórios 4

Campo	Tipo	Descrição
`action`	texto	No corpo.Valores: `create_invite`
`appHash`	texto	No caminho. Hash do aplicativo
`email`	texto	No corpo. E-mail da pessoa convidadaEx.: `pessoa@empresa.com.br`
`group_id`	texto	No corpo. auth_group_id do grupo, de ListarGruposDoAplicativo

Opcionais 1Campos e estruturas que você pode enviar

Campo	Tipo	Descrição
`notify`	sim/não	No corpo. Manda o e-mail de convite (padrão false; para a pessoa saber, use true)

Retorno 2O que volta numa chamada bem-sucedida

Campo	Tipo	Descrição
`invite_id`	texto
`status`	texto	Valores: `OK`

POST /api/portal/apps/{appHash}/invite/

APP_HASH='empresa-abc123'
curl -s -X POST "https://app.omie.com.br/api/portal/apps/${APP_HASH}/invite/" \
  -H "Authorization: Bearer $TOKEN_DE_USUARIO" \
  -H 'Content-Type: application/json' \
  -d '{"action": "create_invite", "email": "pessoa@empresa.com.br", "group_id": "<group_id>", "notify": true}'

import os
import requests

app_hash = "empresa-abc123"

resp = requests.request(
    "POST",
    f"https://app.omie.com.br/api/portal/apps/{app_hash}/invite/",
    headers={"Authorization": f"Bearer {os.environ['TOKEN_DE_USUARIO']}"},
    json={'action': 'create_invite',
 'email': 'pessoa@empresa.com.br',
 'group_id': '<group_id>',
 'notify': True},
    timeout=60,
)
print(resp.json())

const appHash = "empresa-abc123";

const resp = await fetch(`https://app.omie.com.br/api/portal/apps/${appHash}/invite/`, {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.TOKEN_DE_USUARIO}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"action": "create_invite", "email": "pessoa@empresa.com.br", "group_id": "<group_id>", "notify": true}),
});
console.log(await resp.json());

<?php
$appHash = 'empresa-abc123';
$ch = curl_init("https://app.omie.com.br/api/portal/apps/{$appHash}/invite/");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POSTFIELDS => <<<'JSON'
{
    "action": "create_invite",
    "email": "pessoa@empresa.com.br",
    "group_id": "<group_id>",
    "notify": true
}
JSON,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("TOKEN_DE_USUARIO"),
        "Content-Type: application/json",
    ],
]);
echo curl_exec($ch);

require "net/http"

app_hash = 'empresa-abc123'
uri = URI("https://app.omie.com.br/api/portal/apps/#{app_hash}/invite/")
pedido = Net::HTTP::Post.new(uri)
pedido["Authorization"] = "Bearer #{ENV.fetch('TOKEN_DE_USUARIO')}"
pedido["Content-Type"] = "application/json"
pedido.body = <<~'JSON'
{
  "action": "create_invite",
  "email": "pessoa@empresa.com.br",
  "group_id": "<group_id>",
  "notify": true
}
JSON
resp = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(pedido) }
puts resp.body

import java.net.URI;
import java.net.http.*;

var appHash = "empresa-abc123";
var pedido = HttpRequest.newBuilder()
    .uri(URI.create("https://app.omie.com.br/api/portal/apps/" + appHash + "/invite/"))
    .header("Authorization", "Bearer " + System.getenv("TOKEN_DE_USUARIO"))
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("""
{
  "action": "create_invite",
  "email": "pessoa@empresa.com.br",
  "group_id": "<group_id>",
  "notify": true
}
"""))
    .build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());

// TokenDeUsuario: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
    Resposta = Web.Contents(
        "https://app.omie.com.br/api/portal/apps/empresa-abc123/invite/",
        [
            Headers = [Authorization = "Bearer " & TokenDeUsuario, #"Content-Type" = "application/json"],
            Content = Text.ToBinary("{""action"": ""create_invite"", ""email"": ""pessoa@empresa.com.br"", ""group_id"": ""<group_id>"", ""notify"": true}")
        ]
    ),
    Dados = Json.Document(Resposta)
in
    Dados

ListarAplicativos

consulta

Lista de aplicativos do usuário

GET/api/portal/apps/Authorization: Bearer com o token de usuário

Lista os aplicativos (empresas) a que o usuário tem acesso, com o app_hash de cada um, a situação e o api_access (o que o aplicativo precisa para consumir a API).

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 2Campos e estruturas que você pode enviar

Campo	Tipo	Descrição
`doc`	texto	Na consulta (?doc=). Documento (CNPJ ou CPF) do aplicativoEx.: `00.000.000/0001-00`
`q`	texto	Na consulta (?q=). Texto para filtrar aplicativosEx.: `laranja`

Retorno 16O que volta numa chamada bem-sucedida

Campo	Tipo	Descrição
`active`	sim/não	Identifica se o aplicativo está ativoEx.: `true`
`admin_role`	sim/não	Identifica se o usuário atual é administrador do aplicativoEx.: `true`
`api_access`	texto	O que o aplicativo precisa para consumir a API, a mesma classificação do gate de API: TRIAL (demonstração, cota por dia), FREE (plano gratuito, cota por dia), SANDBOX, ALLOWED (addon que libera a API), BLOCKED (precisa de addon na Omie Store) ou null (fora do controle por addon).Valores: `TRIAL`, `FREE`, `SANDBOX`, `ALLOWED`, `BLOCKED`, `null`
`app_hash`	texto	Hash de identificação do aplicativoEx.: `wonka-07djm8`
`app_type`	texto	Tipo do aplicativoEx.: `OMIE`Valores: `OMIE`, `ONEFLOW`
`company_icon`	texto	URL do icone do aplicativoEx.: `https://static.omie.com.br/exemplo/icone.png`
`company_logo`	texto	URL do logotipo do aplicativoEx.: `https://static.omie.com.br/exemplo/logo.png`
`company_nicename`	texto	Ex.: `Wonka - A Fantástica Fábrica`
`contract`	objeto
`contract.contract_id`	número inteiro	ID do tipo de contratoEx.: `13`
`contract.contract_identifier`	texto	Código do contratoEx.: `V6.003`
`contract.contract_label`	texto	Nome amigável do contratoEx.: `Omie.Fit`
`contract.contract_name`	texto	Nome do contratoEx.: `V6`
`evaluation_date`	texto	Data de expiração do aplicativo trialEx.: `2015-02-06T10:44:37-0300`
`is_demo`	sim/não	Identifica se é um aplicativo de demonstraçãoEx.: `true`
`is_pinned`	sim/não	Identifica se o aplicativo está favoritadoEx.: `true`
`online_training_enabled`	sim/não	Identifica se o aplicativo possui consultoria habilitadaEx.: `true`
`purchase_date`	texto	Data que o aplicativo foi assinadoEx.: `2015-02-06T10:44:37-0300`
`purchase_url`	texto	Se é um aplicativo de demonstração, teremos a URL do carrinho de compras
`service_status`	texto	Identifica o status do aplicativoValores: `ACTIVE`, `PENDING`, `ARCHIVED`, `CANCELLED`

GET /api/portal/apps/

curl -s -X GET "https://app.omie.com.br/api/portal/apps/" \
  -H "Authorization: Bearer $TOKEN_DE_USUARIO"

import os
import requests

resp = requests.request(
    "GET",
    "https://app.omie.com.br/api/portal/apps/",
    headers={"Authorization": f"Bearer {os.environ['TOKEN_DE_USUARIO']}"},
    timeout=60,
)
print(resp.json())

const resp = await fetch(`https://app.omie.com.br/api/portal/apps/`, {
  method: "GET",
  headers: {
    "Authorization": `Bearer ${process.env.TOKEN_DE_USUARIO}`,
  },
});
console.log(await resp.json());

<?php
$ch = curl_init("https://app.omie.com.br/api/portal/apps/");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("TOKEN_DE_USUARIO"),
    ],
]);
echo curl_exec($ch);

require "net/http"

uri = URI("https://app.omie.com.br/api/portal/apps/")
pedido = Net::HTTP::Get.new(uri)
pedido["Authorization"] = "Bearer #{ENV.fetch('TOKEN_DE_USUARIO')}"
resp = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(pedido) }
puts resp.body

import java.net.URI;
import java.net.http.*;

var pedido = HttpRequest.newBuilder()
    .uri(URI.create("https://app.omie.com.br/api/portal/apps/"))
    .header("Authorization", "Bearer " + System.getenv("TOKEN_DE_USUARIO"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());

// TokenDeUsuario: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
    Resposta = Web.Contents(
        "https://app.omie.com.br/api/portal/apps/",
        [
            Headers = [Authorization = "Bearer " & TokenDeUsuario]
        ]
    ),
    Dados = Json.Document(Resposta)
in
    Dados

ListarGruposDoAplicativo

consulta

Grupos de permissão

GET/api/portal/apps/{appHash}/groups/Authorization: Bearer com o token de usuário

Os grupos de permissão do aplicativo, com os usuários e as permissões de cada um. O auth_group_id daqui é o group_id do convite. Só para quem administra o aplicativo.

Obrigatórios 1

Campo	Tipo	Descrição
`appHash`	texto	No caminho. Hash do aplicativo

GET /api/portal/apps/{appHash}/groups/

APP_HASH='empresa-abc123'
curl -s -X GET "https://app.omie.com.br/api/portal/apps/${APP_HASH}/groups/" \
  -H "Authorization: Bearer $TOKEN_DE_USUARIO"

import os
import requests

app_hash = "empresa-abc123"

resp = requests.request(
    "GET",
    f"https://app.omie.com.br/api/portal/apps/{app_hash}/groups/",
    headers={"Authorization": f"Bearer {os.environ['TOKEN_DE_USUARIO']}"},
    timeout=60,
)
print(resp.json())

const appHash = "empresa-abc123";

const resp = await fetch(`https://app.omie.com.br/api/portal/apps/${appHash}/groups/`, {
  method: "GET",
  headers: {
    "Authorization": `Bearer ${process.env.TOKEN_DE_USUARIO}`,
  },
});
console.log(await resp.json());

<?php
$appHash = 'empresa-abc123';
$ch = curl_init("https://app.omie.com.br/api/portal/apps/{$appHash}/groups/");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("TOKEN_DE_USUARIO"),
    ],
]);
echo curl_exec($ch);

require "net/http"

app_hash = 'empresa-abc123'
uri = URI("https://app.omie.com.br/api/portal/apps/#{app_hash}/groups/")
pedido = Net::HTTP::Get.new(uri)
pedido["Authorization"] = "Bearer #{ENV.fetch('TOKEN_DE_USUARIO')}"
resp = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(pedido) }
puts resp.body

import java.net.URI;
import java.net.http.*;

var appHash = "empresa-abc123";
var pedido = HttpRequest.newBuilder()
    .uri(URI.create("https://app.omie.com.br/api/portal/apps/" + appHash + "/groups/"))
    .header("Authorization", "Bearer " + System.getenv("TOKEN_DE_USUARIO"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());

// TokenDeUsuario: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
    Resposta = Web.Contents(
        "https://app.omie.com.br/api/portal/apps/empresa-abc123/groups/",
        [
            Headers = [Authorization = "Bearer " & TokenDeUsuario]
        ]
    ),
    Dados = Json.Document(Resposta)
in
    Dados

ListarUsuariosDoAplicativo

consulta

Lista de usuários de um aplicativo

GET/api/portal/apps/{appHash}/users/Authorization: Bearer com o token de usuário

Os usuários e os convites do aplicativo, com o grupo, a situação e quem convidou. Só para quem administra o aplicativo, e só com o aplicativo ativo ou suspenso.

Obrigatórios 1

Campo	Tipo	Descrição
`appHash`	texto	No caminho. Hash do aplicativo

Retorno 1O que volta numa chamada bem-sucedida

Campo	Tipo	Descrição
`users`	lista de objetos
`users[].disass_date`	texto
`users[].disass_reason`	texto
`users[].group_id`	texto	Grupo de permissão (aplicativos que usam grupos)
`users[].invite_date`	texto
`users[].invite_id`	texto
`users[].invite_last_action`	texto
`users[].invited_by`	objeto	Quem convidou
`users[].invited_by.user_email`	texto
`users[].invited_by.user_id`	texto
`users[].invited_by.user_name`	texto
`users[].is_api`	sim/não
`users[].status`	texto	Situação do convite (Pending, Accepted, Canceled)
`users[].user`	objeto
`users[].user.user_email`	texto
`users[].user.user_id`	texto
`users[].user.user_name`	texto

GET /api/portal/apps/{appHash}/users/

APP_HASH='empresa-abc123'
curl -s -X GET "https://app.omie.com.br/api/portal/apps/${APP_HASH}/users/" \
  -H "Authorization: Bearer $TOKEN_DE_USUARIO"

import os
import requests

app_hash = "empresa-abc123"

resp = requests.request(
    "GET",
    f"https://app.omie.com.br/api/portal/apps/{app_hash}/users/",
    headers={"Authorization": f"Bearer {os.environ['TOKEN_DE_USUARIO']}"},
    timeout=60,
)
print(resp.json())

const appHash = "empresa-abc123";

const resp = await fetch(`https://app.omie.com.br/api/portal/apps/${appHash}/users/`, {
  method: "GET",
  headers: {
    "Authorization": `Bearer ${process.env.TOKEN_DE_USUARIO}`,
  },
});
console.log(await resp.json());

<?php
$appHash = 'empresa-abc123';
$ch = curl_init("https://app.omie.com.br/api/portal/apps/{$appHash}/users/");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("TOKEN_DE_USUARIO"),
    ],
]);
echo curl_exec($ch);

require "net/http"

app_hash = 'empresa-abc123'
uri = URI("https://app.omie.com.br/api/portal/apps/#{app_hash}/users/")
pedido = Net::HTTP::Get.new(uri)
pedido["Authorization"] = "Bearer #{ENV.fetch('TOKEN_DE_USUARIO')}"
resp = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(pedido) }
puts resp.body

import java.net.URI;
import java.net.http.*;

var appHash = "empresa-abc123";
var pedido = HttpRequest.newBuilder()
    .uri(URI.create("https://app.omie.com.br/api/portal/apps/" + appHash + "/users/"))
    .header("Authorization", "Bearer " + System.getenv("TOKEN_DE_USUARIO"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());

// TokenDeUsuario: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
    Resposta = Web.Contents(
        "https://app.omie.com.br/api/portal/apps/empresa-abc123/users/",
        [
            Headers = [Authorization = "Bearer " & TokenDeUsuario]
        ]
    ),
    Dados = Json.Document(Resposta)
in
    Dados

Operações

ConsultarAplicativo
ConvidarUsuario
ListarAplicativos
ListarGruposDoAplicativo
ListarUsuariosDoAplicativo