cloudinary

README

Cloudinary Go SDK

About

The Cloudinary Go SDK allows you to quickly and easily integrate your application with Cloudinary. Effortlessly optimize, transform, upload and manage your cloud's assets.

Note

This Readme provides basic installation and usage information. For the complete documentation, see the Go SDK Guide.

Table of Contents

• Key Features
• Version Support
• Installation
• Usage
  • Setup
  • Transform and Optimize Assets

Key Features

• Transform assets.
• Asset Management.
• Secure URLs.

Version Support

SDK Version	Go > 1.13
2.x	v
1.x	v

Installation

go get github.com/cloudinary/cloudinary-go/v2

Usage

Setup

import (
    "github.com/cloudinary/cloudinary-go/v2"
)

cld, _ := cloudinary.New()

• See full documentation.

Transform and Optimize Assets

• See full documentation.

image, err := cld.Image("sample.jpg")
if err != nil {...}

image.Transformation = "c_fill,h_150,w_100"

imageURL, err := image.String()

Upload

• See full documentation.
• Learn more about configuring your uploads with upload presets.

resp, err := cld.Upload.Upload(ctx, "my_picture.jpg", uploader.UploadParams{})

Security options

• See full documentation.

Logging

Cloudinary SDK logs errors using standard go log functions.

For details on redefining the logger or adjusting the logging level, see Logging.

Complete SDK Example

See Complete SDK Example.

Contributions

• Ensure tests run locally
• Open a PR and ensure Travis tests pass
• For more information on how to contribute, take a look at the contributing page.

Get Help

If you run into an issue or have a question, you can either:

• Issues related to the SDK: Open a GitHub issue.
• Issues related to your account: Open a support ticket

About Cloudinary

Cloudinary is a powerful media API for websites and mobile apps alike, Cloudinary enables developers to efficiently manage, transform, optimize, and deliver images and videos through multiple CDNs. Ultimately, viewers enjoy responsive and personalized visual-media experiences—irrespective of the viewing device.

Additional Resources

• Cloudinary Transformation and REST API References: Comprehensive references, including syntax and examples for all SDKs.
• MediaJams.dev: Bite-size use-case tutorials written by and for Cloudinary Developers
• DevJams: Cloudinary developer podcasts on YouTube.
• Cloudinary Academy: Free self-paced courses, instructor-led virtual courses, and on-site courses.
• Code Explorers and Feature Demos: A one-stop shop for all code explorers, Postman collections, and feature demos found in the docs.
• Cloudinary Roadmap: Your chance to follow, vote, or suggest what Cloudinary should develop next.
• Cloudinary Facebook Community: Learn from and offer help to other Cloudinary developers.
• Cloudinary Account Registration: Free Cloudinary account registration.
• Cloudinary Website: Learn about Cloudinary's products, partners, customers, pricing, and more.

Licence

Released under the MIT license.

Documentation

Index

• type Cloudinary
  • func New() (*Cloudinary, error)
  • func NewFromConfiguration(configuration config.Configuration) (*Cloudinary, error)
  • func NewFromOAuthToken(cloud string, oAuthToken string) (*Cloudinary, error)
  • func NewFromParams(cloud string, key string, secret string) (*Cloudinary, error)
  • func NewFromURL(cloudinaryURL string) (*Cloudinary, error)
  • func (c Cloudinary) File(publicID string) (*asset.Asset, error)
  • func (c Cloudinary) Image(publicID string) (*asset.Asset, error)
  • func (c Cloudinary) Media(publicID string) (*asset.Asset, error)
  • func (c Cloudinary) SearchURL(query search.Query) (*asset.SearchURLAsset, error)
  • func (c Cloudinary) Video(publicID string) (*asset.Asset, error)

Types

type Cloudinary

type Cloudinary struct {
	Config config.Configuration
	Admin  admin.API
	Upload uploader.API
	Logger *logger.Logger
}

Cloudinary main struct

func New

func New() (*Cloudinary, error)

New returns a new Cloudinary instance from environment variable.

func NewFromConfiguration

func NewFromConfiguration(configuration config.Configuration) (*Cloudinary, error)

NewFromConfiguration returns a new Cloudinary instance from the provided configuration.

func NewFromOAuthToken

func NewFromOAuthToken(cloud string, oAuthToken string) (*Cloudinary, error)

NewFromOAuthToken returns a new Cloudinary instance from the provided cloud name and OAuth token.

func NewFromParams

func NewFromParams(cloud string, key string, secret string) (*Cloudinary, error)

NewFromParams returns a new Cloudinary instance from the provided parameters.

func NewFromURL

func NewFromURL(cloudinaryURL string) (*Cloudinary, error)

NewFromURL returns a new Cloudinary instance from a cloudinary url.

func (Cloudinary) File

func (c Cloudinary) File(publicID string) (*asset.Asset, error)

File creates a new asset.File instance.

func (Cloudinary) Image

func (c Cloudinary) Image(publicID string) (*asset.Asset, error)

Image creates a new asset.Image instance.

func (Cloudinary) Media

func (c Cloudinary) Media(publicID string) (*asset.Asset, error)

Media creates a new asset.Media instance.

func (Cloudinary) SearchURL

func (c Cloudinary) SearchURL(query search.Query) (*asset.SearchURLAsset, error)

SearchURL creates a new asset.SearchURL instance.

func (Cloudinary) Video

func (c Cloudinary) Video(publicID string) (*asset.Asset, error)

Video creates a new asset.Video instance.