Přehled Rentall API

Vítejte v dokumentaci Rentall API. Na této stránce vám dáváme rychlý přehled, jak se k Rentall.cz připojit a co od API čekat.

Základní URL: https://rentall.cz
Formát: JSON přes HTTPS
Autorizace: Bearer token (viz Autentizace, hlavičky a chyby)

Co je k dispozici

Produkty — položky katalogu k pronájmu
- Přehled: /products
- Endpointy: výpis, detail podle ID, vytvoření (podle ID), aktualizace, smazání
Pronajímatelé (Rents) — profily/pronajímatelé; používá se také pro přihlášení
- Přehled: /rents
- Endpointy: výpis, vytvoření, detail podle ID, aktualizace, smazání
OpenAPI (stahovatelná specifikace): /openapi

Rychlý start s autentizací

Přihlaste se a získejte token


curl -s -X POST \
	-H "Content-Type: application/json" \
	-d '{"email":"info@rentall.cz","password":"<password>"}' \
	https://rentall.cz/api/rents/login

Odpověď (zkráceně): { "token": "<JWT>", "user": { "id": "..." } }

curl


curl -s -X POST \
	-H "Content-Type: application/json" \
	-d '{"email":"info@rentall.cz","password":"<password>"}' \
	https://rentall.cz/api/rents/login

JavaScript


const res = await fetch("https://rentall.cz/api/rents/login", {
	method: "POST",
	headers: { "Content-Type": "application/json" },
	body: JSON.stringify({ email: "info@rentall.cz", password: "<password>" })
});
const { token, user } = await res.json();
console.log(token, user?.id);

TypeScript


interface LoginResponse { token: string; user?: { id: string } }
const res = await fetch("https://rentall.cz/api/rents/login", {
	method: "POST",
	headers: { "Content-Type": "application/json" },
	body: JSON.stringify({ email: "info@rentall.cz", password: "<password>" })
});
const data: LoginResponse = await res.json();
console.log(data.token);

PHP


<?php
$payload = json_encode([ 'email' => 'info@rentall.cz', 'password' => '<password>' ]);
$ch = curl_init('https://rentall.cz/api/rents/login');
curl_setopt_array($ch, [
	CURLOPT_RETURNTRANSFER => true,
	CURLOPT_POST => true,
	CURLOPT_HTTPHEADER => [ 'Content-Type: application/json' ],
	CURLOPT_POSTFIELDS => $payload
]);
$resp = curl_exec($ch);
if ($resp === false) throw new Exception(curl_error($ch));
curl_close($ch);

Volání endpointů s tokenem


curl -s \
	-H "Authorization: Bearer $RENTALL_TOKEN" \
	https://rentall.cz/api/products?limit=10

curl


curl -s \
	-H "Authorization: Bearer $RENTALL_TOKEN" \
	https://rentall.cz/api/products?limit=10

JavaScript


const token = process.env.RENTALL_TOKEN ?? "<JWT>";
const res = await fetch("https://rentall.cz/api/products?limit=10", {
	headers: { Authorization: `Bearer ${token}` }
});
const list = await res.json();
console.log(list.page, list.docs?.length);

TypeScript


const token = (process.env.RENTALL_TOKEN ?? "<JWT>") as string;
const res = await fetch("https://rentall.cz/api/products?limit=10", {
	headers: { Authorization: `Bearer ${token}` }
});
const list: { page?: number; docs?: unknown[] } = await res.json();
console.log(list.page, list.docs?.length);

PHP


<?php
$token = getenv('RENTALL_TOKEN');
$ch = curl_init('https://rentall.cz/api/products?limit=10');
curl_setopt_array($ch, [
	CURLOPT_RETURNTRANSFER => true,
	CURLOPT_HTTPHEADER => [ 'Authorization: Bearer ' . $token ]
]);
$resp = curl_exec($ch);
if ($resp === false) throw new Exception(curl_error($ch));
curl_close($ch);

Poznámka:

Některé projekty používají místo hlavičky Authorization httpOnly cookies. Detaily najdete v Autentizaci.

Konvence

Stránkování: page (výchozí 1), limit (výchozí 10)
Řazení: sort (např. -createdAt, basic.product_name)
Filtrování: where jako JSON objekt (např. { "settings.published": { "equals": true } })
Content-Type: application/json pro zápisové operace (POST/PATCH)

Typické tvary odpovědí

Stránkovaný výpis:


{
	"docs": [ /* items */ ],
	"page": 1,
	"totalPages": 5,
	"limit": 10,
	"hasNextPage": true
}

Chyby:


{
	"errors": [
		{ "message": "Validation failed: basic.product_name is required", "field": "basic.product_name" }
	]
}

Důležitý vztah v datech

products.additional.selectedTerm odkazuje na ID podmínek pronájmu v rámci vlastníka produktu: basic.rent_owner.terms.termsArray[].id.

Kontakt

Dotazy a přístup: info@rentall.cz