Contents

ShootProof API Guide

The ShootProof API is a RESTful, hypermedia API that uses OAuth 2.0 for authorization and bearer tokens for authentication.

Did you just win buzzword bingo?

We designed our API to be easy to use and navigate. Get tokens using the industry-standard OAuth 2.0 authorization framework, and navigate the API using links.

Tip

Download our OpenAPI 3.0 document to use OpenAPI tools to integrate with the ShootProof API.

Here are a few tips to help you get started:

First, read about hypermedia and link relations to learn the basics behind how the ShootProof API works.
Next, check out our authorization section, which describes the OAuth 2.0 flow.
Your app will use the access token granted during the OAuth 2.0 flow to make authenticated requests.
Make an authenticated request to our service description endpoint to find out what you can do.

Afterwards, you may check out the rest of the links in this guide section, or head over to the API reference to learn more.