Journey

Appearance

JourneyID API Reference ​

Welcome to the JourneyID API documentation. This guide provides comprehensive information about our RESTful API endpoints and how to integrate with our services.

Base URL ​

All API requests should be made to:

https://api.journeyid.com

For WebSocket connections, use:

wss://ws.journeyid.com

Authentication ​

JourneyID uses a SECRET_KEY to authenticate requests. You can find your SECRET_KEY in the developer settings section of your JourneyID account.

Using SECRET_KEY ​

Include your SECRET_KEY in all API requests to the server in the Authorization header:

Authorization: Bearer YOUR_SECRET_KEY

Security Best Practices ​

  • Keep your SECRET_KEY secure and never share it publicly
  • Rotate your SECRET_KEY regularly
  • Use environment variables to store your SECRET_KEY
  • Never commit your SECRET_KEY to version control

Common Response Codes ​

  • 200 OK: Request successful
  • 201 Created: Resource created successfully
  • 400 Bad Request: Invalid request parameters
  • 401 Unauthorized: Invalid or missing Secret Key
  • 403 Forbidden: Insufficient permissions
  • 404 Not Found: Resource not found
  • 429 Too Many Requests: Rate limit exceeded
  • 500 Internal Server Error: Server error

Error Response Format ​

json
{
  "error": "Human readable error message",
  "errors?": {
    "field1": "Error message 1",
    "field2": "Error message 2"
  }
}

Available Endpoints ​

For detailed information about each endpoint, please refer to the specific documentation:

Support ​

For additional support or questions about the API, please contact our support team at support@journeyid.com.