The ōgol API

IMPORTANT: This API is currently under development and may change without notice.

URL Scheme

The ōgol API is organized around a simple URL structure that utilizes subdomains to indicate various actions to perform on an endpoint. The URL structure is as follows:

http://:action.ogol.io/:domain/

URL PARTS

This structure allows for using ōgol web URLs and declaring actions on them by simply changing the subdomain. For example, the ōgol page at:

http://ogol.io/google.com

Will produce the default image render by simply prepending "img" to the URL like so:

http://img.ogol.io/google.com

If you use the same URL structure, but change the subdomain to "dl" the URL will force the browser to download the same file:

http://dl.ogol.io/google.com

Image API

The Image API is used for rendering logos with URL specified parameters. The image API also supports rendering collections, and in the case where the collection has a registered domain name, the domain can be used as the collectionId. The URL structure is as follows:

http://img.ogol.io/:domain/:logoKey.format?arguments

Example:

http://img.ogol.io/google.com/nn0ymd.png?w=200&h=300

URL PARTS

ARGUMENTS

Download API

The Download API works just like the image API, but forces the browser to download the output rather than display it. The download API also supports rendering collections, and in the case where the collection has a registered domain name, the domain can be used as the collectionId. The URL structure is as follows:

http://dl.ogol.io/:domain/:logoKey.format?arguments

Example:

http://dl.ogol.io/google.com/nn0ymd.png?w=200&h=300

URL PARTS

ARGUMENTS