Skip to main content

Delivery Locker API Introduction

Welcome to the KioskForce Delivery Locker API documentation. This API enables seamless integration with our network of smart delivery lockers, providing secure package storage and automated retrieval solutions.

Getting Started​

The Delivery Locker Cloud API provides comprehensive integration capabilities for delivery service providers to interact with KioskForce delivery lockers. The API allows you to:

  • Search for available lockers by location and radius
  • Reserve locker compartments for package deliveries
  • Control locker doors for drop-off and pickup operations
  • Manage reservations with cancellation and abandonment options
  • Receive real-time webhooks for delivery events

What you'll need​

  • API credentials (X-API-Key) from KioskForce
  • HTTPS-enabled endpoint for webhook delivery (optional)
  • Package dimensions for optimal locker matching
  • Basic understanding of REST APIs and JSON

Quick Start​

To begin using the Delivery Locker API:

  1. Get API credentials - Contact KioskForce to obtain your X-API-Key
  2. Test connectivity - Use the echo endpoint to verify your integration
  3. Search for lockers - Find available lockers in your delivery area
  4. Make your first reservation - Reserve a locker compartment
# Test API connectivity
curl -X POST "https://api.delivery.vendingontrack.com/api/delivery/external/v1/echo" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"message": "test"}'

# Search for nearby lockers
# Search for nearby lockers
curl -X POST "https://api.delivery.vendingontrack.com/api/delivery/external/v1/machines/search" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "latitude": -6.125556,
    "longitude": 106.655830,
    "radius": 1000
  }'

Authentication​

All API requests require authentication using an API key in the X-API-Key header:

X-API-Key: YOUR_API_KEY

Base URL​

Production: https://api.delivery.kioskforce.com Staging: https://api-staging.delivery.kioskforce.com

Rate Limiting​

The API is rate limited to 1000 requests per hour per API key. Rate limit headers are included in all responses:

  • X-RateLimit-Limit: Request limit per hour
  • X-RateLimit-Remaining: Requests remaining in current window
  • X-RateLimit-Reset: Unix timestamp when the rate limit resets

Support​

Need help getting started? Our developer support team is here to assist:

Next Steps​

Ready to dive deeper? Check out our comprehensive guides: