Quick Start

Get your API keys

Our API is authenticated using API keys. Any request that doesn't include an API key will return an error.

To get your API key, go to the "Settings" page from the upper-right menu. In the left, you shall see an "API" tab. There you can copy your API token.

Install the library

The best way to interact with our API is to use one of our official libraries:

Node

# Install via NPM
npm install --save socialsplash

Create your first image

To make your first image, you can directly To make your first request, send an authenticated request to the pets endpoint. This will create a pet, which is nice.

Take a look at how you might call this method using our official libraries, or via curl:

curl

curl https://api.socialsplash.app/me/images  
    -u YOUR_API_KEY:  
    -d title='My example'  
    -d description='This is an example description'

Node

// require the myapi module and set it up with your API key
const SocialSplash = require('socialsplash');

const splash = new SocialSplash({
  apiKey: '<your-api-key>',
})

const imageUrl = splash.signedUrl('<template-uuid>', {
    title: 'My example',
    description: 'This is an example description that will be used in the template'
})

// "imageUrl" is now a signed URL that you can reference to.