Quickstart

This guide will get you all set up and ready to use the Uprise API. We'll cover how to get started using one of our API clients and how to make your first API request. We'll also look at where to go next to find all the information you need to take full advantage of our powerful REST API.

Choose your client

Before making your first API request, you need to pick which API client to test the API. You can use either cURL HTTP requests or Postman for testing purposes.

# cURL is most likely already installed on your machine
  curl --version

Get an access token

Before calling any API resource, exchange your client credentials for a Bearer token. Send a POST request to the Auth token endpoint with Basic authentication: Base64-encode clientId:clientSecret and pass the result in the Authorization header.

curl https://staging-api.uprise.us/auth/token \
  -X POST \
  -H "Authorization: Basic $(echo -n '{clientId}:{clientSecret}' | base64)" \
  -H "Content-Type: application/json"

{
  "access_token": "{access token}",
  "token_type": "bearer",
  "expires_in": 3590
}

Use the access_token value as your Bearer token in subsequent requests. Tokens expire after about an hour (expires_in is in seconds), so request a new one when needed.

Making your first API request

After you have an access token, you are ready to make your first call to the Uprise API. Below, you can see how to send a GET request to the Users endpoint to get a list of all your users. Replace {token} with the access_token from the previous step.

curl 'https://beta-api.uprise.us/users?limit=10' \
  -H "Authorization: Bearer {token}"

What's next?

Great, you're now set up with an API client and have made your first request to the API. Here are a few links that might be handy as you venture further into the Uprise API:

• Learn how authentication works
• Check out the Users endpoint
• Learn about the different error messages