OAuth Overview

The OAuth API is primarily used for sites that have already taken the steps to set up Web Monetization and want to offer a way for Coil Members to access monetized content on mobile and on desktop without the Coil Extension installed.

info

You can implement basic Web Monetization on your site without access to our OAuth API.

If you're already familiar with Web Monetization, read about our OAuth Web Monetization Script. The script is available for any site that uses Coil's OAuth and allows users to sign in to their Coil account from your site.

Get started

Before you can use the OAuth API, you must:

After you are approved for OAuth access, register your client app and wait for a registration access token. Then, use the access token to register your app with the Coil OpenID Connect (OIDC) provider. The registration process is outlined on the POST /oauth/reg page.

OpenID Connect settings

The Coil OIDC and OAuth2 provider uses the oidc-provider package, which implements the specs described by openid.net.

Openid-configuration is the Coil OIDC provider's discovery document. The document describes the API endpoints used during the authentication sequence. You'll need these details to construct requests to the server. Specifying this URL connects the authenticator to the OIDC provider.

SettingValue
Discovery Endpointhttps://coil.com/.well-known/openid-configuration
Authorization Scopesimple_wm and openid

Basic OAuth flow

This section provides the basic flow for being approved for, and then accessing, resources owned by Coil users. The Coil OIDC and OAuth2 provider uses the authorization code flow. Steps 1 - 5 below are covered in the previous sections on this page.

  1. Sign up for a free Coil account if you don't already have one.
  2. Email [email protected] and outline your use case.
  3. Wait for approval.
  4. When approved, register your client app and wait for your registration access token.
  5. After you have a registration access token, register your app with the Coil OIDC provider to exchange the token for a client ID and client secret.
  6. Get permission for your app to access resources owned by a Coil user.
  7. Request an access token.
  8. Get the resources that the app was previously granted access to.
  9. Issue the Coil user a BTP token.

Endpoints

POST /oauth/regGET /oauth/authPOST /oauth/token