Entwicklerreferenz
API-Dokumentation
Erstellen Sie Integrationen mit der NearbyAssist-Plattform. RESTful-Endpunkte, konsistente JSON-Antworten und umfassende Abdeckung für Buchungen, Nachrichten, Abrechnung und mehr.
Basis-URL
https://api.nearbyassist.comAuthentifizierung
Bearer-Token über den Header Authorization
Anfragegrenzen
500 Req/15 Min (global), 20 Req/15 Min (Auth-Endpunkte)
Format
JSON-Anfragen/-Antworten. UTF-8-Kodierung. ISO 8601-Daten.
Authentifizierung
Alle authentifizierten Endpunkte erfordern einen Bearer-Token im Authorization-Header. Erhalten Sie ein Token durch Anmeldung über POST /api/auth/signin. Für Partnerintegrationen verwenden Sie einen API-Schlüssel mit dem X-API-Key-Header.
# Session token (user authentication)
curl https://api.nearbyassist.com/api/users/profile \
-H "Authorization: Bearer <access_token>"
# API key (partner integration)
curl https://api.nearbyassist.com/api/integrations/partner/bookings \
-H "X-API-Key: na_live_..."
Holen Sie sich Ihren API-Schlüssel
Generieren Sie API-Schlüssel über das Integrations-Dashboard. Schlüssel verwenden das Präfix na_live_ und unterstützen begrenzte Berechtigungen (bookings:read, bookings:write usw.). Der vollständige Schlüssel wird nur einmal bei der Erstellung angezeigt.
Authentifizierung
(3 Endpunkte)Benutzer
(3 Endpunkte)Unternehmen
(7 Endpunkte)Buchungen
(8 Endpunkte)Dienstleistungen
(4 Endpunkte)Bewertungen & Fragen
(6 Endpunkte)Nachrichten
(5 Endpunkte)Abrechnung & Zahlungen
(6 Endpunkte)Personal
(5 Endpunkte)Integrationen
(7 Endpunkte)Webhooks
(3 Endpunkte)Fehlerantworten
Alle Fehler geben einen JSON-Körper mit error und optionalem errors-Array für Validierungsfehler zurück.
{
"error": "Validation failed",
"errors": [
{ "field": "email", "message": "Email is required" },
{ "field": "password", "message": "Minimum 8 characters" }
]
}| Code | Status | Beschreibung |
|---|---|---|
| 200 | OK | Request succeeded. |
| 201 | Created | Resource created successfully. |
| 400 | Bad Request | Invalid request body or query parameters. |
| 401 | Unauthorized | Missing or invalid authentication token. |
| 403 | Forbidden | Authenticated but lacking permission for this resource. |
| 404 | Not Found | Resource does not exist. |
| 409 | Conflict | Resource conflict (e.g. duplicate booking slot). |
| 422 | Unprocessable Entity | Validation failed. Check the errors array in the response. |
| 429 | Too Many Requests | Rate limit exceeded. Retry after the Retry-After header value. |
| 500 | Internal Server Error | Unexpected error. Contact support if persistent. |
Seitenumbruch
Listenendpunkte unterstützen cursorbasierte Paginierung mit den Parametern page und limit. Standardlimit ist 20, Maximum ist 100.
GET /api/bookings/my-bookings?page=2&limit=10
{
"bookings": [...],
"total": 47,
"page": 2,
"limit": 10
}Webhook-Ereignisse
Registrieren Sie Webhook-Endpunkte für Echtzeit-Benachrichtigungen. Alle Payloads enthalten einen X-NearbyAssist-Signature-Header zur Verifizierung mit HMAC-SHA256.
booking.createdA new booking is confirmed.booking.updatedBooking status or time changed.booking.cancelledA booking was cancelled.lead.receivedNew lead available for your business.lead.acceptedA lead was accepted and charged.review.createdNew review posted for your business.message.receivedInbound message from any channel.payment.completedA payment was processed successfully.// Verify webhook signature
const crypto = require('crypto');
const signature = req.headers['x-nearbyassist-signature'];
const expected = crypto
.createHmac('sha256', webhookSecret)
.update(JSON.stringify(req.body))
.digest('hex');
if (signature !== expected) {
return res.status(401).json({ error: 'Invalid signature' });
}Integration Guide
Step-by-step walkthrough for OAuth, API keys, and common integration scenarios.
OpenAPI Spec
Download the OpenAPI 3.0 YAML spec. Import into Swagger UI or code generators.
Postman Collection
Pre-configured Postman collection with all endpoints ready to test.
Need help integrating?
Our developer support team is available to help with integration questions, debugging, and best practices.