Skip to main content

Introduction

This documentation covers everything you need to know about using Custom API Domains with Ricardoneud.com.
You can configure your own branded domain, secure it with SSL, and manage it seamlessly from the dashboard.

​
Why Use Custom Domains?

Benefits

  • Branded API endpoints: Replace the default api.ricardoneud.com with your own domain.
  • Enhanced security: All traffic is automatically secured with HTTPS via SSL certificates.
  • Professional appearance: Provide clients and developers with a fully branded experience.
  • Automated workflow: DNS validation, SSL provisioning, verification, and renewal are handled automatically.

​
Step 1: Configure DNS

CNAME Setup

  1. Log in to your domain registrar or DNS provider.
  2. Create a CNAME record pointing to api.zone-bind.com.
Example:
Your DomainTypeValue
api.yourdomain.comCNAMEapi.zone-bind.com
⚠️ Notes:
  • DNS propagation can take up to 24–48 hours.
  • Ensure no conflicting records exist (e.g., A records on the same subdomain).

DNS Validation

  • Once the DNS is correctly configured and propagated, validation is automatically completed.
  • After DNS validation, SSL provisioning begins without any manual steps.

​
Step 2: Add Your Domain on Ricardoneud.com

Domain Registration

  1. Go to your Ricardoneud.com Dashboard → Custom Domains
  2. Enter your domain in the Add Domain field
  3. Click Add Domain to register
Example:Custom Domain: test.ricardoneud.comThe domain will automatically progress through validation, SSL provisioning, verification, and activation.

Domain Status

  • Once DNS validation succeeds, SSL provisioning and verification are handled automatically.
  • The domain is considered Completed when it is fully secure and ready for production.

​
Step 3: Automatic SSL Management

SSL Management

  • SSL certificates are automatically requested and issued via Let’s Encrypt.
  • Verification and renewal are fully automated; no manual intervention is required.
Example SSL Status:
DomainSSL StatusAPI Endpoint
test.ricardoneud.comSSL Activehttps://test.ricardoneud.com
⚠️ Tips:
  • Ensure your domain resolves publicly for automatic SSL provisioning.
  • All API traffic will automatically use HTTPS once SSL is active.

SSL Troubleshooting

Automated SSL minimizes errors, but common issues include:
  • Domain not publicly accessible: Ensure DNS is correctly configured and propagated.
  • Propagation delays: SSL provisioning may take a few minutes depending on DNS.

​
Step 4: Use Your Custom Domain

API Endpoint Usage

Once your custom domain is active and SSL is configured, use it in all API requests:
GET https://test.ricardoneud.com/v4/example-endpoint
Advantages:
  • Branded domain for client applications
  • Consistent and professional URL
  • Fully secured with HTTPS

​
Advanced Features

Available Features

  • Custom API Domain: Branded endpoints for your API requests
  • Automatic SSL Provisioning: Certificates issued instantly after DNS validation
  • Automatic SSL Verification: Status and expiration handled in real time
  • Automatic SSL Renewal: Certificates renewed without manual intervention
  • DNS Validation: Fully automated with real-time completion

​
Notes & Best Practices

Important Tips

  • Use your custom domain in production instead of api.ricardoneud.com
  • Verify your domain resolves publicly to allow automatic SSL provisioning
  • Monitor your dashboard for domain and SSL status updates
  • Test API endpoints over HTTPS to ensure proper configuration

​
FAQ

Frequently Asked Questions

Q: How long does SSL generation take?
A: Usually a few minutes after DNS propagation; fully automated.Q: What happens if SSL expires?
A: Renewal is automatic, ensuring continuous HTTPS availability.
⌘I