A step-by-step walkthrough of the API

These guides will help you setup an app on Nymbol and get started consuming and creating content. They don't focus on specific platforms, but rather cover the REST API and steps you need to take on the Nymbol website.

The first thing you'll need to do is setup your app on the Nymbol website, so that you can obtain an API key and secret.

Structural overview

A Nymbol account can contain a number of collections and apps. Each collection contains a number of objects, known to the API as assets. Throughout the guides, we're using the PubCrawl app as an example. This app lists pubs around the UK (starting off in Birmingham, the city where Nymbol was created). All the pubs are grouped together in a single collection, and each asset within the collection represents a particular pub.

Each pub can have a number of photos, videos and links. These are called resources, and can always contain plain text but can also contain a variety of hosted media, or links to media that is hosted elsewhere (like YouTube videos or Flickr images).

Apps allow you to access the content via the API. Each app can be bound to one or more collections, which means only apps that authenticate themselves to the API can see those collections (no data is available to apps unless explicitly specified).

Terms used in these guides

You'll see the term "content curator" used a lot throughout these guides. A content curator is someone who uses the Nymbol site to manage their collection: add new objects, approve user-contributed content, that sort of thing. If you're a one-person show, you will be the content curator; if you're a freelancer or part of an agency, your client is probably the curator.

Within these guides, you can consider the terms "object" and "asset" to be interchangeable. We try and use the terms that apply best to the context, but they mean exactly the same thing. Content curators working on the Nymbol site will see the word "Object", whereas the API deals with "assets".