Account

Key's account

GET/api/v1/me

Returns the account the key sees. It is the call to test a key and learn the account identifier.

Key scope

Any key of the account (read is enough).

Parameters

Name	In	Type	Required	Description
`Authorization`	header	string	yes	Bearer followed by the key. Alternative: X-API-Key header.

Response fields

Name	Type	Description
`tenant`	integer	Account identifier.
`nome`	string	Name.
`cnpj`	string	Account CNPJ.
`plano`	string	Subscribed plan.
`api`	string	API version that answered.

Status codes

HTTP	Description
200	OK
401	Missing or invalid key

Error messages

HTTP	Message (erro field)	When it happens
401	`chave de API ausente ou inválida`	No key header, revoked key or typo.
401	`chave sem empresa vinculada`	The key exists but is not linked to an account. Create another one in Settings › API.
403	`conta de demonstração: a API pública está desligada na vitrine`	The call reached the demo account, where the public API is turned off.
403	`identidade da chave de API irregular`	The account refuses keys with irregular identity (deactivated person or ownerless key). The body brings motivo and comoResolver.
429	`limite de requisições excedido (120/min)`	The key went over its per-minute limit. Wait for Retry-After.
200, with erro in the body	`não foi possível carregar o tenant`	The account could not be read. Comes with status 200.

Request example

cURL

curl "https://tenka.app.br/api/v1/me" \
  -H "Authorization: Bearer $TENKA_API_KEY"

JavaScript

const response = await fetch("https://tenka.app.br/api/v1/me", {
  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/me",
    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/me"))
    .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/me");
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/me");
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 generated from the contract — download at 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.getMe({});
console.log(data);

Response example

200 · application/json

{
  "tenant": 42,
  "nome": "Comercial Aurora Ltda",
  "cnpj": "12.345.678/0001-00",
  "plano": "Evoluir",
  "api": "v1"
}

Generated from OpenAPI contract v1.2.0, the same one openapi.json publishes. openapi.json