Getting Started

connect({ apiKey: String }) => Connection

The Greenruhm SDK is structured to be self documenting, meaning that you only see the API functions that make sense in your current context. For example, if you haven't configured connect yet, you won't be able to see the user or drop APIs. To get started, you'll first need to import connect and pass it your API key:

import connect from '@greenruhm/connect';

const connection = connect({ apiKey: '<your api key here>' });

Now that it's configured, you'll be able to see the user API, but you won't be able to manage a user's drops until you have signed up or signed in with a user. Note: connect is synchronous and stores your API key for future requests without doing any asynchronous authentication up front. If you API key is wrong, connection methods will reject with authentication errors.