Getting Started

Steemconnect supports two different oauth flows for authorization.

Implicit grant flow

• You create an authorization link with your app’s client id and permission scopes.
• User visits the page (steemconnect) and authorizes the application with the given permission scopes.
• steemconnect returns user to the your app with a access token in the query string.

From that point, you can use this access token to broadcast operations on user’s behalf.

Code authorization flow

access tokens has a short TTL on Oauth standards. Every time a user has their token expired, you have two choices:

• Re-log the user and get a fresh token
• Add “offline” scope to the required scopes and get a refresh token to refresh the access tokens.

The second approach is required on some cases for the dApps and you will need to use Code authorization flow this. When you add the “offline” scope to the required scopes, you will get a code instead of access token.

With this code, you can get new access tokens till forever. (As long as the user don’t revoke access of your app.)

Note

All of these flows are covered at steemconnect-python-client, however have a look to Steemconnect wiki.

to learn more about it.

Creating your app on Steemconnect

You need to register your app into steemconnect before working with them. This will provide client_id and client_secret information which you will need to interact with the API.

Redirecting user

from steemconnect.client import Client

c = Client(
    client_id="app_name",
    client_secret="client_secret",
)

At this point, we need to redirect the user to steemconnect for they to log in. That requires creating a URL.

auth_url = c.get_login_url(
    "http://callback.to.your.app",
    "login,vote",
)

• The first parameter is the callback URL when the user authorizes your app on SteemConnect.
• Second parameter is the scopes you need. Available scopes are listed at Steemconnect wiki.

Important

If you need to use the Code authorization flow, you need to pass get_refresh_token=True to this function. Also, “offline” scope is mandatory.

Once the user authorizes your app, steemconnect will redirect the user to your app with an access token or code depending the flow you choose. If you get a code in the query string, you can use this code to create access tokens for the specified user.

c.get_access_token(
    code,
)

Example output

{
    'access_token': 'access_token_string',
    'expires_in': 604800,
    'username': 'emrebeyler',
    'refresh_token': 'refresh_token_string'
}

If you use the Implicit grant flow, then you may skip this step.

Continue with Using access tokens to learn what can you do with the access tokens.