Como adicionar empresas a uma conta?
Neste artigo você encontra o passo a passo para cadastrar uma nova empresa e iniciar o uso da aplicação.
Entre em contato com a equipe de Implantação pelo e-mail implantacao@oobj.com.br para solicitar as credenciais necessárias para a utilização deste endpoint.
Adicionar empresas
Para começar, faça uma requisição tipo POST ao endpoint adicionar empresas;
[URL_BASE]/api/empresas
No corpo da requisição (
request body
) preencha os seguintes parâmetros:{chaveAtivacaoBase64}
*: informação fornecida pela Oobj;{consultaSincrona}
*: se a comunicação com a Sefaz é síncrona ou assíncrona. Valores aceitos: true ou false;{cpfCnpj}
*: CPF ou CNPJ da empresa a cadastrar;{municipio}
*: município da empresa. Caso informado diferente do código IBGE é obrigatório preencher a UF;{nomeExibicao }
*: nome fantasia da empresa;{razaoSocial }
*: razão social da empresa;{uf}
*: sigla da UF. Valores aceitos: AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE ou TO;
- Informe o x-auth-token no cabeçalho (
header parameters
) da requisição.
Exemplo de request body
{
"chaveAtivacaoBase64": "string",
"consultaSincrona": false,
"cpfCnpj": "41761386026 ou 743.549.530-13 ou 59803732000162 ou 98.593.567/0001-13",
"municipio": "5208707 ou Goiânia",
"nomeExibicao": "string",
"razaoSocial": "string",
"uf": "GO"
}
Exemplo de requisição
O exemplo abaixo traz um modelo de requisição preenchido para adicionar uma empresa.
A requisição contém dados fictícios, somente para demonstração.
curl -L -X POST 'https://rest-teste.oobj.com.br/api/empresas' \
-H 'Content-Type: application/json' \
-H 'x-auth-token: eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI3Yjc2OTg1ZGQ2MTNhOWVlYTFiN2RmZTNiZjRhMTRiZiIsImF1ZCI6IndlYiIsImV4cCI6MTYyOTI5MDcwNiwiaWF0IjoxNjI5Mjg4OTA2fQ.-Dj91d6fBZYcZpy1-zKzohAWd5dgW2CAS5BBfwGilemUYcOVDm8CnrDJHbwsFyixI5ohphy-65fqeobXkimtCg' \
--data-raw '{
"chaveAtivacaoBase64": "string",
"consultaSincrona": false,
"cpfCnpj": "41761386026 ou 743.549.530-13 ou 59803732000162 ou 98.593.567/0001-13",
"municipio": "5208707 ou Goiânia",
"nomeExibicao": "string",
"razaoSocial": "string",
"uf": "GO"
}'
Exemplo de retorno
{
[
{
"nome": "",
"cnpj": "07385111000102",
"logo": null,
"cscs": [
{
"uf": "RS",
"sequencial": 3,
"token": "3PWX3KGA-KO8I-BPFN-1GD1-4VHOUXKZTWGYB",
"validade": "2021-02-14 03:00:00",
"ambiente": 2
}
]
}
]
}
Pronto! Você acaba de adicionar a sua empresa na aplicação.