Leitura

Lista rolos

GET/api/v1/rolos

Lista os registros da conta, nos dois modos: página a página (limit e offset) ou incremental (desde e depoisDe). Registro na lixeira não aparece.

Escopo da chave

Qualquer chave da conta (leitura basta).

Parâmetros

Nome	Onde	Tipo	Obrigatório	Descrição
`Authorization`	header	string	sim	Bearer seguido da chave. Alternativa: cabeçalho X-API-Key.
`limit`	query	integer · padrão 50 · máx. 200	não	Máx. de itens (até 200).
`offset`	query	integer · padrão 0	não	Deslocamento para paginação.
`desde`	query	string	não	Só o que mudou a partir deste instante (ISO-8601: 2026-08-27 ou 2026-08-27T14:30:00). Ativa o modo incremental: a resposta traz proximoDesde/proximoId/temMais, que você devolve na chamada seguinte.
`depoisDe`	query	integer	não	Use o proximoId da resposta anterior, junto com proximoDesde em 'desde'. Desempata registros gravados no mesmo instante.

Campos da resposta

Envelope da resposta

Nome	Tipo	Descrição
`data`	array	Os registros da página.
`moeda`	string	Moeda funcional da conta (ISO 4217) em que os valores estão.
`limit`	integer	O limit aplicado.
`offset`	integer	O offset aplicado.
`count`	integer	Quantos registros vieram nesta página.
`desde`	string	Só no modo incremental: o corte aplicado.
`temMais`	boolean	Há outra página.
`proximoDesde`	string	Só no modo incremental: devolva em desde na chamada seguinte.
`proximoId`	integer	Só no modo incremental: devolva em depoisDe na chamada seguinte.

Cada registro em data[]

Nome	Tipo	Descrição
`id`	integer	Identificador do registro. Use-o nas chamadas por id.
`idItem`	string	id do item (artigo, fio ou peça) da conta.
`lote`	string	Lote de produção do material.
`numeroRolo`	string	Número do rolo dentro do lote.
`pesoLiquido`	string	Peso líquido em kg.
`metragem`	string	Comprimento em metros.
`situacao`	string	Situação do registro, no vocabulário da tela.
`idDeposito`	string	id do depósito onde o registro está.
`idOrdemProducao`	string	id da ordem de produção.
`idPartida`	string	id da partida de tingimento.
`idRemessa`	string	id da remessa de beneficiamento.
`atualizadoEm`	string (data e hora)	Só no modo incremental: quando o registro foi criado ou alterado pela última vez.

Códigos de status

HTTP	Descrição
200	OK
401	Chave ausente ou inválida
429	Rate-limit (120/min) excedido

Mensagens de erro

HTTP	Mensagem (campo erro)	Quando acontece
401	`chave de API ausente ou inválida`	Sem cabeçalho de chave, chave revogada ou digitada errada.
401	`chave sem empresa vinculada`	A chave existe mas não está ligada a uma conta. Gere outra em Configurações › API.
403	`conta de demonstração: a API pública está desligada na vitrine`	A chamada veio para a conta de demonstração: lá a API pública fica desligada.
403	`identidade da chave de API irregular`	A conta recusa chaves com identidade irregular (pessoa desligada ou chave sem dono). O corpo traz motivo e comoResolver.
429	`limite de requisições excedido (120/min)`	Passou do limite por minuto da chave. Espere o Retry-After.
200, com erro no corpo	`parâmetro 'desde' inválido — use 2026-08-27 ou 2026-08-27T14:30:00`	O parâmetro desde não é data nem data e hora. Vem com status 200.
200, com erro no corpo	`parâmetro 'depoisDe' inválido — use o proximoId da resposta anterior`	O parâmetro depoisDe não é número. Vem com status 200.
200, com erro no corpo	`falha ao consultar`	A consulta falhou do nosso lado. Vem com status 200; repita mais tarde e, persistindo, veja a página de status.

Exemplo de chamada

cURL

curl "https://tenka.app.br/api/v1/rolos?limit=50" \
  -H "Authorization: Bearer $TENKA_API_KEY"

JavaScript

const response = await fetch("https://tenka.app.br/api/v1/rolos?limit=50", {
  method: "GET",
  headers: {
    "Authorization": "Bearer " + TENKA_API_KEY
  }
});
const data = await response.json();
if (!response.ok || data.erro) throw new Error(response.status + " " + data.erro);
console.log(data);

Python

import os
import requests

response = requests.get(
    "https://tenka.app.br/api/v1/rolos?limit=50",
    headers={
        "Authorization": f"Bearer {os.environ['TENKA_API_KEY']}",
    },
    timeout=30,
)
data = response.json()
if not response.ok or "erro" in data:
    raise RuntimeError(f"{response.status_code} {data.get('erro')}")
print(data)

Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder(URI.create("https://tenka.app.br/api/v1/rolos?limit=50"))
    .header("Authorization", "Bearer " + System.getenv("TENKA_API_KEY"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());

using System.Net.Http.Headers;
using System.Text;

using var http = new HttpClient();
http.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("TENKA_API_KEY"));
var request = new HttpRequestMessage(HttpMethod.Get, "https://tenka.app.br/api/v1/rolos?limit=50");
var response = await http.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");

PHP

<?php
$ch = curl_init("https://tenka.app.br/api/v1/rolos?limit=50");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("TENKA_API_KEY"),
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
$data = json_decode($body, true);
echo $status . " " . $body;

Node (SDK)

// SDK gerado do contrato — baixe em https://tenka.app.br/api/v1/sdk/tenka.js
import { Tenka } from "./tenka.js";

const tenka = new Tenka(process.env.TENKA_API_KEY, "https://tenka.app.br/api/v1");
const data = await tenka.getRolos({ limit: 50 });
console.log(data);

Exemplo de resposta

200 · application/json

{
  "data": [
    {
      "id": 123,
      "idItem": "texto",
      "lote": "texto",
      "numeroRolo": "texto",
      "pesoLiquido": "texto",
      "metragem": "texto",
      "situacao": "texto",
      "idDeposito": "texto",
      "idOrdemProducao": "texto",
      "idPartida": "texto",
      "idRemessa": "texto"
    }
  ],
  "moeda": "BRL",
  "limit": 50,
  "offset": 0,
  "count": 1
}

Gerado do contrato OpenAPI v1.2.0, o mesmo que o openapi.json publica. openapi.json