Cloudinary's SDK libraries wrap Cloudinary's APIs, enabling you to implement comprehensive image and video upload, manipulation, optimization, and delivery capabilities in your application, using code that integrates seamlessly with your existing application code.
SDKs are available for most popular programming languages include server-side, client-side, and mobile.
The Cloudinary SDK Guides provide information on installing, setting up, and getting started with Cloudinary using your selected SDK.
|Server-side SDKs||Client-side SDKs||Mobile SDKs|
|Ruby on Rails||React||iOS (Swift/ObjectiveC)|
|PHP v2 Beta ❘ PHP v1||Angular||Android|
The first step in setting up your chosen SDK is to set the global configuration parameters in the relevant configuration file (see the relevant SDK guide above for details on where and how to configure them for your SDK).
cloud_name account identifier, and your account
api_secret are mandatory settings for all server-side operations, there are also a number of optional parameters you may want to define. You can also set these parameters in individual Cloudinary operations, which then overrides the global configuration settings.
The table below details all available configuration parameters (mandatory and optional).
For details and examples of where and how to define these configuration parameters, see the relevant Cloudinary SDK framework guide.
- Keep in mind that in some SDK languages, you may need to adjust the case (for example to camelCase or kebab-case) to match the conventions of the language you are using.
- All Boolean options are false by default.
|cloud_name||string||Mandatory. The name of your Cloudinary account. Used to build the public URL for all your media assets.|
|api_key||string||Mandatory for server-side operations. Used together with the API secret to communicate with the Cloudinary API and sign requests.|
|api_secret||string||Mandatory for server-side operations. Used together with the API key to communicate with the Cloudinary API and sign requests.|
|secure||Boolean||Optional. Force HTTPS URLs for asset delivery even if they are embedded in non-secure HTTP pages. When using this option with a custom domain name (CNAME), specify your CNAME using the
|cname||string||Optional. The custom domain name to use for building HTTP URLs. Use this option only if you do not set
|secure_distribution||string||Optional. The custom domain name to use for building HTTPS URLs. Use this option in conjunction with the
|private_cdn||Boolean||Optional. Set this parameter to true if you are an Advanced plan user with a private CDN distribution. For details, see Private CDNs and CNAMEs.|
|cdn_subdomain||Boolean||Optional. Whether to automatically build URLs with multiple CDN sub-domains. In most cases, this is no longer necessary. For details, see Multiple sub-domains.|
|provisioning_api_key||string||Mandatory for Provisioning API operations. Used together with the Provisioning API secret to communicate with the Cloudinary API and authenticate provisioning requests.|
|provisioning_api_secret||string||Mandatory for Provisioning API operations. Used together with the Provisioning API key to communicate with the Cloudinary API and authenticate provisioning requests.|
|account_id||string||Mandatory for Provisioning API operations. The ID of the Cloudinary account for provisioning.|
|upload_preset||string||Optional. The name of a defined upload preset. You create upload presets in Upload Settings of the Media Library. This is especially useful for client-side SDKs. If you are planning to offer unsigned uploads, you can define an unsigned upload preset to use with all uploads.|
|static_image_support||Boolean||Relevant for Ruby on Rails SDK only. Optional. Whether to deliver uploaded static images through Cloudinary. For details, see Rails Static images.|
|enhance_image_tag||Boolean||Relevant for Ruby on Rails SDK only. Optional. Whether to wrap the standard
Set this parameter to true if
The most recent 5 versions of the following browsers are regularly tested with Cloudinary's SDKs and are officially supported:
- Google Chrome
- Internet Explorer 11
- Microsoft Edge
- Mozilla Firefox
- Mobile Chrome
- Mobile Firefox
- Mobile Safari
If there is another popular browser that you think we should add to our browser support matrix, please submit a support request and we will evaluate it.