Network.Bitcoin.BitX.Private.Auth

The single function in this module, allows your application to use the private BitX API via OAuth2.

To use OAuth2, you first need to contact the BitX team [e-mail], and provide them with * Application name * Application description * Website URL * Permissions required * Redirect URL * Your BitX account username

Next, the user needs to be sent to https://bitx.co/oauth2/authorize?client_id=your_client_id&scope=your_requested_permissions&state=your_unique_state, where they can confirm the request. If they do confirm the request, they will be sent to your redirect URL, with an authorisation code as one of the GET parameter: https://example.com/callback?code=authorization_code&state=your_unique_state

The permissions are explained in the Network.Bitcoin.BitX.Private module.

Documentation

authGrant :: BitXClientAuth -> Text -> IO (BitXAPIResponse BitXAuth)

Grant

Once your application has received an authorization code, it can exchange it for an API key. This is done by calling the grant endpoint. The resulting API key can be used to access the BitX API calls for which it has the appropriate permissions.