Powrót do wyboru API

Dokumentacja API GrobNet

API głównego systemu dla zakładów pogrzebowych

Wprowadzenie

API GrobNet umożliwia dostęp do danych zakładów pogrzebowych w formacie JSON. Wszystkie endpointy są publiczne i nie wymagają uwierzytelniania.

Base URL: https://grobnet.eu/api

Format odpowiedzi: JSON

Kodowanie: UTF-8

Uwierzytelnianie

Obecnie wszystkie endpointy API są publiczne i nie wymagają uwierzytelniania. W przyszłości może zostać dodana autoryzacja przez token API.

Endpointy

Metoda Endpoint Opis
GET /api/funeral-homes Lista zakładów pogrzebowych
GET /api/funeral-homes/{id} Szczegóły zakładu pogrzebowego

GET /api/funeral-homes

Pobiera listę aktywnych zakładów pogrzebowych z planami PAID i PREMIUM.

Parametry zapytania:
Parametr Typ Wymagany Domyślna wartość Opis
plan_type string Nie all Typ planu: PAID, PREMIUM lub all
limit integer Nie 100 Maksymalna liczba wyników
offset integer Nie 0 Przesunięcie dla paginacji
Przykład żądania:
GET https://grobnet.eu/api/funeral-homes?plan_type=PREMIUM&limit=10&offset=0
Przykład odpowiedzi:
{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "Zakład Pogrzebowy XYZ",
      "description": "Opis zakładu...",
      "address": "ul. Przykładowa 123, Warszawa",
      "phone": "+48 123 456 789",
      "email": "kontakt@zaklad.pl",
      "website": "https://zaklad.pl",
      "logo": "/assets/uploads/funeral-homes/logo.jpg",
      "plan_type": "PREMIUM",
      "featured": true,
      "views_count": 150,
      "created_at": "2024-01-15 10:30:00",
      "expires_at": "2025-01-15 10:30:00",
      "gallery_images": [
        "/assets/uploads/funeral-homes/gallery1.jpg",
        "/assets/uploads/funeral-homes/gallery2.jpg"
      ],
      "owner": {
        "email": "wlasciciel@zaklad.pl",
        "name": "Jan Kowalski"
      }
    }
  ],
  "count": 1,
  "limit": 10,
  "offset": 0
}
Kody odpowiedzi:
  • 200 - Sukces
  • 500 - Błąd serwera

GET /api/funeral-homes/{id}

Pobiera szczegółowe informacje o wybranym zakładzie pogrzebowym.

Parametry ścieżki:
Parametr Typ Wymagany Opis
id integer Tak ID zakładu pogrzebowego
Przykład żądania:
GET https://grobnet.eu/api/funeral-homes/1
Przykład odpowiedzi:
{
  "success": true,
  "data": {
    "id": 1,
    "name": "Zakład Pogrzebowy XYZ",
    "description": "Szczegółowy opis zakładu...",
    "address": "ul. Przykładowa 123, 00-001 Warszawa",
    "phone": "+48 123 456 789",
    "email": "kontakt@zaklad.pl",
    "website": "https://zaklad.pl",
    "logo": "/assets/uploads/funeral-homes/logo.jpg",
    "plan_type": "PREMIUM",
    "featured": true,
    "views_count": 150,
    "created_at": "2024-01-15 10:30:00",
    "expires_at": "2025-01-15 10:30:00",
    "gallery_images": [
      "/assets/uploads/funeral-homes/gallery1.jpg",
      "/assets/uploads/funeral-homes/gallery2.jpg"
    ],
    "services": [
      {
        "id": 1,
        "name": "Pogrzeb tradycyjny",
        "description": "Kompleksowa organizacja pogrzebu...",
        "price": 5000.00
      },
      {
        "id": 2,
        "name": "Kremacja",
        "description": "Usługa kremacji...",
        "price": 2500.00
      }
    ],
    "opening_hours": {
      "monday": "8:00 - 16:00",
      "tuesday": "8:00 - 16:00",
      "wednesday": "8:00 - 16:00",
      "thursday": "8:00 - 16:00",
      "friday": "8:00 - 16:00",
      "saturday": "8:00 - 14:00",
      "sunday": "Zamknięte"
    },
    "coordinates": {
      "latitude": 52.2297,
      "longitude": 21.0122
    },
    "owner": {
      "email": "wlasciciel@zaklad.pl",
      "name": "Jan Kowalski"
    }
  }
}
Kody odpowiedzi:
  • 200 - Sukces
  • 404 - Nie znaleziono zakładu
  • 500 - Błąd serwera
{ "id": "0_3", "nazwa": "poniżej 3.0", "liczba_zakladow": 10 } ] } }

Kody błędów

Oto lista kodów błędów, które mogą zostać zwrócone przez API:

Kod błędu Opis HTTP Status
400 Nieprawidłowe żądanie 400 Bad Request
404 Nie znaleziono zasobu 404 Not Found
422 Nieprawidłowe dane wejściowe 422 Unprocessable Entity
429 Przekroczono limit zapytań 429 Too Many Requests
500 Wewnętrzny błąd serwera 500 Internal Server Error
503 Serwis niedostępny 503 Service Unavailable