Documentation

Ruby API

The United Notifications Ruby API enables you to send notifications seamlessly by making HTTP POST requests. Using Ruby's Net::HTTP module, you can integrate this functionality into your application with ease. This guide provides a detailed explanation of the API usage, along with a working example.

Code Example

Below is an example of how to send a notification using Ruby:

require 'net/http'
require 'uri'

response = Net::HTTP.post_form(
  URI("https://api.united-notifications.com"), 
  {
    client_key: 'f31c320dcd',
    channel: '[channel-token]',
    type: 'info',
    title: 'This is a info-notification',
    body: 'This is the body.',
    critical: 0
  }
)

puts response.body

Make sure to replace the placeholder values such as [channel-token] and f31c320dcd with your actual channel token and API client key.

Parameters

When sending a notification, the following parameters are required:

client_key: Your API client key used for authentication.
channel: The unique identifier for the channel where the notification will be sent.
type: The type of notification. Options include:
- info: General information notifications.
- warning: Alerts requiring attention.
- error: Critical issue notifications.
title: A concise title for the notification.
body: The detailed message content of the notification.
critical: A boolean value (0 for false, 1 for true) indicating if the notification is critical.

API Endpoint

The endpoint for sending notifications is:

https://api.united-notifications.com

All requests should be made using the HTTP POST method with form-encoded parameters.

Response

The API will return a response indicating the success or failure of the request. Typically, the response includes:

status: Indicates whether the request was successful (success) or encountered an error (error).
message: Provides additional information about the operation or error encountered.
data: (Optional) Contains additional details or metadata about the notification.

The response body can be printed or logged for debugging purposes, as shown in the example code.

Security Considerations

To secure your integration, follow these best practices:

Always use HTTPS to ensure data is encrypted during transmission.
Keep your client_key confidential and avoid exposing it in public repositories.
Validate API responses to confirm successful delivery of notifications.
Use environment variables to store sensitive credentials securely.

Troubleshooting

If you encounter issues, consider the following steps:

Ensure the endpoint URL (https://api.united-notifications.com) is accessible from your environment.
Verify the accuracy of your client_key and channel values.
Check for typos or incorrect parameter names in your request.
Inspect the API response for error messages to identify specific problems.
Log responses and errors for debugging and diagnostics.

Usage Tips

To ensure optimal performance:

Consider implementing retries for failed requests to handle temporary network issues.
Log all API interactions for debugging and tracking.
Use asynchronous requests for high-throughput scenarios to avoid blocking your main application thread.

By integrating the Ruby API for United Notifications, you can effectively deliver real-time notifications to your users, enhancing their experience and engagement.

Did you find this page helpful?

These might also be helpful