Services API

GET /api/services

Retrieve a list of all services and organizations available in Dzaleka Refugee Camp.

Query Parameters

This endpoint does not require any query parameters.

Response Format

string

required

Status of the API response (“success” or “error”)

number

required

Total number of services returned

object

required

Container for the services data

array

required

Array of service objects

string

Unique identifier for the service

string

Collection name (“services”)

string

Name of the service or organization

string

Service category (e.g., “Education”, “Legal Services”, “Technology”)

string

Detailed description of the service

object

Physical location information

string

Street address

string

City name

object

GPS coordinates

number

Latitude

number

Longitude

object

Contact information

string

Email address

string

Phone number

string

Operating hours

Social media links

string

Facebook URL

string

Twitter/X URL

string

Instagram URL

string

LinkedIn URL

string

Website URL

string

URL to organization logo

boolean

Whether the service is featured

boolean

Whether the service is verified

string

Last update date (YYYY-MM-DD)

Error Responses

string

“error”

string

Error message description

string

Detailed error information

Status Codes:

200 - Success
429 - Rate limit exceeded (60 requests per minute)
500 - Internal server error

Rate Limiting

All API endpoints are rate-limited to 60 requests per minute per IP address. Rate limit headers are included in responses:

X-RateLimit-Limit: Maximum requests per window
X-RateLimit-Remaining: Remaining requests in current window
X-RateLimit-Reset: Timestamp when the rate limit resets
Retry-After: Seconds to wait before retrying (only on 429 responses)

Example Request

curl -X GET "https://services.dzaleka.com/api/services" \
  -H "Content-Type: application/json"

Example Response

{
  "status": "success",
  "count": 2,
  "data": {
    "services": [
      {
        "id": "BloomBox",
        "collection": "services",
        "title": "BloomBox Design Labs",
        "category": "Education",
        "description": "BloomBox Design Labs is dedicated to the application of sustainable design strategies, materials, and energy to advancing access to high quality education.",
        "location": {
          "address": "BloomBox, Dzaleka, M16",
          "city": "Dowa",
          "coordinates": {
            "lat": -13.6628274,
            "lng": 33.8704301
          }
        },
        "contact": {
          "email": "",
          "phone": "+1 236-888-5055",
          "hours": "Monday-Friday, 9:00 AM - 5:00 PM"
        },
        "socialMedia": {
          "facebook": "",
          "twitter": "https://x.com/roux_sofie",
          "instagram": "https://www.instagram.com/bloomboxdesignlabs/?hl=en",
          "linkedin": "",
          "website": "https://www.bloomboxdesignlabs.com/"
        },
        "logo": "https://static.wixstatic.com/media/bd2625_69e11c70797246ccba3425b1b8bcd771%7Emv2.png/v1/fill/w_192%2Ch_192%2Clg_1%2Cusm_0.66_1.00_0.01/bd2625_69e11c70797246ccba3425b1b8bcd771%7Emv2.png",
        "featured": true,
        "verified": true,
        "lastUpdated": "2025-03-06"
      }
    ]
  }
}

POST /api/services

Retrieve services data with optional metadata and statistics.

Request Body

object

Optional configuration for the response

boolean

Include export metadata in response

boolean

Include statistics in response

Response Format

Same as GET endpoint, with optional additional fields:

object

Export metadata (only if includeMetadata: true)

string

ISO 8601 timestamp of export

string

Collection name

object

Statistics (only if includeStats: true)

number

Total number of items

string

Collection name

Example Request

curl -X POST "https://services.dzaleka.com/api/services" \
  -H "Content-Type: application/json" \
  -d '{
    "options": {
      "includeMetadata": true,
      "includeStats": true
    }
  }'

Example Response

{
  "status": "success",
  "count": 45,
  "data": {
    "services": [
      {
        "id": "BloomBox",
        "title": "BloomBox Design Labs",
        "category": "Education"
      }
    ]
  },
  "metadata": {
    "exportDate": "2025-03-09T12:00:00.000Z",
    "collection": "services"
  },
  "stats": {
    "totalItems": 45,
    "collection": "services"
  }
}

Implementation

The Services API is implemented using the createGetHandler and createPostHandler utility functions from src/utils/api-utils.ts:118. Source code: src/pages/api/services.ts:5

Getting Started

Endpoints

Data Models

GET /api/services

Query Parameters

Response Format

Error Responses

Rate Limiting

Example Request

Example Response

POST /api/services

Request Body

Response Format

Example Request

Example Response

Implementation

​GET /api/services

​Query Parameters

​Response Format

​Error Responses

​Rate Limiting

​Example Request

​Example Response

​POST /api/services

​Request Body

​Response Format

​Example Request

​Example Response

​Implementation

GET /api/services

Query Parameters

Response Format

Error Responses

Rate Limiting

Example Request

Example Response

POST /api/services

Request Body

Response Format

Example Request

Example Response

Implementation