Listar empresas emissoras
curl --request GET \
--url https://api.engineapi.com.br/v1/companies \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.engineapi.com.br/v1/companies"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.engineapi.com.br/v1/companies', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.engineapi.com.br/v1/companies",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.engineapi.com.br/v1/companies"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.engineapi.com.br/v1/companies")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.engineapi.com.br/v1/companies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
{
"id": "<string>",
"cnpj": "<string>",
"name": "<string>",
"ambienteFiscal": 123,
"avisos": [
{
"code": "MUNICIPIO_NAO_ADERENTE_PADRAO_NACIONAL",
"message": "<string>",
"ambiente": 1,
"consultadoEm": "2023-11-07T05:31:56Z"
}
],
"tradeName": "<string>",
"ie": "<string>",
"im": "<string>",
"crt": 123,
"email": "<string>",
"phone": "<string>",
"cep": "<string>",
"address": "<string>",
"number": "<string>",
"complement": "<string>",
"neighborhood": "<string>",
"city": "<string>",
"state": "<string>",
"ibgeCode": "<string>",
"fiscalBrainEnabled": true,
"valorAproximadoTributosEnabled": true,
"canalPortaAPorta": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"prontoPara": {
"nfse": true,
"nfe": true,
"nfce": true,
"sandbox": true,
"faltando": {
"nfse": [
"<string>"
],
"nfe": [
"<string>"
],
"nfce": [
"<string>"
]
},
"cobertura": {
"situacao": "aderente",
"consultadoEm": "2023-11-07T05:31:56Z"
}
},
"sugestoesServicoPadrao": [
"<unknown>"
]
}
]Empresas
Listar empresas emissoras
Lista todos os emissores (Issuers) cadastrados pelo parceiro autenticado, com o id (UUID) usado como issuerId na emissão de notas. Cada item traz prontoPara: { nfse, nfe, nfce, sandbox, faltando } (readiness por documento — o mesmo campo do GET por id) e avisos[] (aviso nomeado só com município não aderente confirmado).
GET
/
v1
/
companies
Listar empresas emissoras
curl --request GET \
--url https://api.engineapi.com.br/v1/companies \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.engineapi.com.br/v1/companies"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.engineapi.com.br/v1/companies', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.engineapi.com.br/v1/companies",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.engineapi.com.br/v1/companies"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.engineapi.com.br/v1/companies")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.engineapi.com.br/v1/companies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
{
"id": "<string>",
"cnpj": "<string>",
"name": "<string>",
"ambienteFiscal": 123,
"avisos": [
{
"code": "MUNICIPIO_NAO_ADERENTE_PADRAO_NACIONAL",
"message": "<string>",
"ambiente": 1,
"consultadoEm": "2023-11-07T05:31:56Z"
}
],
"tradeName": "<string>",
"ie": "<string>",
"im": "<string>",
"crt": 123,
"email": "<string>",
"phone": "<string>",
"cep": "<string>",
"address": "<string>",
"number": "<string>",
"complement": "<string>",
"neighborhood": "<string>",
"city": "<string>",
"state": "<string>",
"ibgeCode": "<string>",
"fiscalBrainEnabled": true,
"valorAproximadoTributosEnabled": true,
"canalPortaAPorta": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"prontoPara": {
"nfse": true,
"nfe": true,
"nfce": true,
"sandbox": true,
"faltando": {
"nfse": [
"<string>"
],
"nfe": [
"<string>"
],
"nfce": [
"<string>"
]
},
"cobertura": {
"situacao": "aderente",
"consultadoEm": "2023-11-07T05:31:56Z"
}
},
"sugestoesServicoPadrao": [
"<unknown>"
]
}
]Authorizations
Token JWT obtido via /v1/auth/login
Response
200 - application/json
Lista de empresas do parceiro, cada uma com prontoPara e avisos[] (sem segredos).
- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$Show child attributes
Show child attributes