Configuring Nginx to Use Dolibarr's REST API

The REST API of Dolibarr enables seamless integration with third-party applications, providing a robust solution for interacting with the features of this open-source ERP/CRM. To use this API in a high-performance web environment, it is often necessary to configure Nginx as a web server. In this article, we provide a detailed guide on configuring Nginx to leverage Dolibarr's REST API, complete with practical examples and optimization tips.

1. Prerequisites for Configuration

Before starting the configuration, ensure that you have:

• A server with Nginx installed and operational.
• PHP installed with the necessary extensions for Dolibarr (e.g., php-curl, php-json, php-mbstring, etc.).
• Dolibarr installed and running on the server.
• An SSL certificate (optional but recommended for securing API access).

2. Why Use Nginx with Dolibarr's REST API?

Nginx is a popular choice as a web server for its performance, efficient handling of concurrent requests, and configuration flexibility. When properly configured, Nginx can:

• Improve API request response times.
• Provide an additional security layer (e.g., SSL/TLS).
• Efficiently manage redirects and headers required for REST API usage.

3. Basic Nginx Configuration for Dolibarr

Here are the steps needed to enable Nginx to handle requests to Dolibarr's REST API:

Create an Nginx Configuration File for Dolibarr:

server {
    listen 80;
    server_name example.com;
    root /var/www/html/dolibarr/htdocs;

    # Redirect to HTTPS
    return 301 https://$host$request_uri;
}

server {
    listen 443 ssl;
    server_name example.com;

    root /var/www/html/dolibarr/htdocs;
    index index.php index.html;

    # SSL Certificates
    ssl_certificate /etc/ssl/certs/example.com.crt;
    ssl_certificate_key /etc/ssl/private/example.com.key;

    # Logs
    access_log /var/log/nginx/dolibarr.access.log;
    error_log /var/log/nginx/dolibarr.error.log;

    location / {
        try_files $uri $uri/ /index.php?$query_string;
    }

    location ~ \.php$ {
        include fastcgi_params;
        fastcgi_pass unix:/var/run/php/php7.4-fpm.sock;
        fastcgi_index index.php;
        fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
    }

    location ~ /conf/ {
        deny all;
    }
}

Enable the Configuration and Restart Nginx:

ln -s /etc/nginx/sites-available/dolibarr.conf /etc/nginx/sites-enabled/
nginx -t  # Check configuration validity
systemctl reload nginx

4. Testing Dolibarr's REST API

The REST API of Dolibarr is accessible via the following URL after configuration: https://example.com/api/index.php.

To test, you can use cURL or an API client like Postman:

curl -X GET https://example.com/api/index.php/users -H "DOLAPIKEY: your_api_key"

5. Optimization and Security

To secure and optimize access to the REST API:

• Enable CORS: Add the necessary headers in your Nginx configuration.
• Restrict Access: Allow only specific IP addresses.
• Increase File Size Limits: Configure client_max_body_size for large files.

Conclusion

Configuring Nginx to utilize Dolibarr's REST API enables you to fully leverage the capabilities of this ERP/CRM in a fast and secure web environment. With this guide and the provided examples, you can integrate and optimize your Nginx server to meet your business's specific needs.