Consultar Prestador

curl --request GET \
  --url https://notasx-api.fly.dev/v1/prestadores/{prestador_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://notasx-api.fly.dev/v1/prestadores/{prestador_id}', 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://notasx-api.fly.dev/v1/prestadores/{prestador_id}",
  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://notasx-api.fly.dev/v1/prestadores/{prestador_id}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://notasx-api.fly.dev/v1/prestadores/{prestador_id}")

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

{
  "ambiente": "homologacao",
  "ativo": true,
  "certificado_valido_ate": "2027-04-28T12:00:00Z",
  "cnpj": "12345678000195",
  "codigo_municipio": "2408102",
  "id": "3891f091-65d6-4a88-ac60-72dbe3e98319",
  "inscricao_municipal": "1234567",
  "op_simp_nac": 3,
  "razao_social": "Exemplo Serviços LTDA"
}

{
  "erro": {
    "codigo": "nao_autenticado",
    "mensagem": "Credencial ausente, inválida ou revogada."
  }
}

{
  "erro": {
    "codigo": "nao_encontrado",
    "mensagem": "Prestador não encontrado."
  }
}

{
  "erro": {
    "codigo": "requisicao_invalida",
    "mensagem": "corpo.cnpj: String should match pattern '^\\d{14}$'"
  }
}

{
  "erro": {
    "codigo": "limite_de_requisicoes",
    "mensagem": "Muitas requisições; tente de novo em instantes."
  }
}

GET

prestadores

{prestador_id}

Consultar Prestador

curl --request GET \
  --url https://notasx-api.fly.dev/v1/prestadores/{prestador_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://notasx-api.fly.dev/v1/prestadores/{prestador_id}', 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://notasx-api.fly.dev/v1/prestadores/{prestador_id}",
  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://notasx-api.fly.dev/v1/prestadores/{prestador_id}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://notasx-api.fly.dev/v1/prestadores/{prestador_id}")

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

{
  "ambiente": "homologacao",
  "ativo": true,
  "certificado_valido_ate": "2027-04-28T12:00:00Z",
  "cnpj": "12345678000195",
  "codigo_municipio": "2408102",
  "id": "3891f091-65d6-4a88-ac60-72dbe3e98319",
  "inscricao_municipal": "1234567",
  "op_simp_nac": 3,
  "razao_social": "Exemplo Serviços LTDA"
}

{
  "erro": {
    "codigo": "nao_autenticado",
    "mensagem": "Credencial ausente, inválida ou revogada."
  }
}

{
  "erro": {
    "codigo": "nao_encontrado",
    "mensagem": "Prestador não encontrado."
  }
}

{
  "erro": {
    "codigo": "requisicao_invalida",
    "mensagem": "corpo.cnpj: String should match pattern '^\\d{14}$'"
  }
}

{
  "erro": {
    "codigo": "limite_de_requisicoes",
    "mensagem": "Muitas requisições; tente de novo em instantes."
  }
}

Authorizations

Authorization

string

header

required

Authorization: Bearer nx_... com uma Chave de API, ou o JWT de sessão do painel (Supabase Auth). As duas credenciais representam a mesma Conta.

Path Parameters

prestador_id

string<uuid>

required

Id do Prestador, devolvido no cadastro.

Response

Successful Response

string<uuid>

required

Id do Prestador no NotasX.

cnpj

string

required

CNPJ, só dígitos.

Razão social informada no cadastro.

codigo_municipio

string | null

required

Código IBGE do município.

inscricao_municipal

string | null

required

Inscrição municipal, se informada.

op_simp_nac

integer | null

required

1 não optante, 2 MEI, 3 ME/EPP do Simples Nacional.

ambiente

enum<string>

required

Ambiente das próximas Notas. Começa em homologacao; muda com ativar-producao.

Available options:

homologacao,

producao

ativo

boolean

required

true quando há Certificado ativo do próprio CNPJ.

certificado_valido_ate

string<date-time> | null

required

Validade do Certificado ativo; null sem Certificado.

Notas

Conta

Prestadores

Chaves de API

Consultar Prestador

Authorizations

Path Parameters

Response