Authentication & API Keys

Arifa uses API keys to identify your application.

Types of Keys

TypePurposeExpiration
Live KeyProduction useNever
Test KeyDevelopment only4 hours

Passing the API Key

API keys are included in:

  • WebSocket URL query parameters
  • HTTP POST body when sending notifications

Example (WebSocket URL)

wss://notifications.arifa.dev/ws/connect?api_key=YOUR_API_KEY&recipient=UUID&client=web or mobile

recipient must be a valid UUID v4.