👨‍💻Authorizing users

Step 1. Redirecting users to SellSN

You'll need to redirect your users to SellSN to begin the authorization process, you can use the following URL template to do so.

https://dash.sellsn.io/oauth2/[App ID]

You can pass more arguments to the login page, find below a table of all the URL query parameters you can set

Parameter	Required?	Example	Description
redirectUrl		https://my-site.com/return/sellsn	The authorized return URL to redirect users to after authorization has completed.
state		abc	The state to pass down to the redirect URL once authorized, can store specific values that might be useful to your application.

Step 2. Handling the return

Next, you'll need to exchange the returned access code for an API key to access the users account.

Once authorized, the user will be redirected to the given redirect URL in the previous step and we'll automatically add the following query parameters to the URL which you will need to perform the access code exchange process.

Parameter	Description
code	The access code for the exchange process, lasts 1 minute after issuance.
state	The state from the previous step (if provided).

Now, you can make a request to our API to get an API key to access the users account.

You need to provide your OAuth2 client secret only for the exchange access code request in the XOAuth2-Client-Secret header or your request will not be authorized.

Exchange access code

Exchanges the given access code for the OAuth2 application into an API key

GEThttps://api.sellsn.io/oauth2/{appId}/exchange/{code}

Path parameters

appId*string (uuid)

The ID of the OAuth2 application

code*string

The access code to exchange into an API key

Response

200401403404

The object was successfully returned.

Body

text/plainapplication/jsontext/json

successboolean

Whether the operation was successful

messagenullable string

The optional message given by the operation

datanullable string

The optional return data from the operation

Request

JavaScriptCurlPython

const response = await fetch('https://api.sellsn.io/oauth2/{appId}/exchange/{code}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401403404

{
  "success": false,
  "message": "text",
  "data": "text"
}

And voila, you should have a valid JWT API key for the user in the data field of the exchange response.

Step 3. Using the API key

You from now can use the API key issued to access any endpoint that your app has permissions to access which is previously defined in your app settings. For example if I have users.view permissions then I can make a request to the Get User endpoint as seen below as long as I pass the API key in the Authorization header, for example Authorization: Bearer abc

Get user

Gets the currently signed-in user account data, requires the Scopes.ViewUser permission

GEThttps://api.sellsn.io/user

Response

200401403

The object was successfully returned.

Body

text/plainapplication/jsontext/json

successboolean

Whether the operation was successful

messagenullable string

The optional message given by the operation

dataUserResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.sellsn.io/user', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401403

{
  "success": false,
  "message": "text",
  "data": {
    "id": "text",
    "dateCreated": "2024-09-19T02:42:23.640Z",
    "plan": "text",
    "setupCompletionState": 0,
    "email": "text",
    "userName": "text",
    "allowMarketplace": false,
    "stores": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2024-09-19T02:42:23.640Z",
        "name": "text",
        "description": "text",
        "url": "\n                store\n            ",
        "customDomain": "text",
        "termsOfService": "text",
        "copyright": "text",
        "privacyPolicy": "text",
        "preferredCurrency": "text",
        "isVerified": false,
        "prependProductNameToReceipt": false,
        "featuredProduct": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "dateCreated": "2024-09-19T02:42:23.640Z",
          "name": "text",
          "description": "text",
          "tags": [
            "text"
          ],
          "imageNames": [
            "text"
          ],
          "cost": 0,
          "type": 0,
          "subscriptionPeriod": "text",
          "ignoreOutOfStock": false,
          "isPinned": false,
          "isDynamic": false,
          "rating": 0,
          "visibility": 0,
          "customValueKeys": [
            "text"
          ],
          "requireDiscordAuthorization": false,
          "useDiscordIntegration": false
        },
        "rating": 0,
        "theme": {},
        "socialMediaAccounts": {
          "tikTok": "text",
          "youTube": "text",
          "twitter": "text",
          "facebook": "text",
          "discord": "text",
          "telegram": "text",
          "instagram": "text"
        },
        "profileImage": "text",
        "scopes": [
          "text"
        ],
        "isDiscordBotConfigured": false,
        "domain": "text"
      }
    ],
    "twoFactorEnabled": false,
    "discordWebhookUrl": "text",
    "lastPasswordUpdate": "2024-09-19T02:42:23.640Z",
    "cashAppOptions": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "dateCreated": "2024-09-19T02:42:23.640Z",
      "isEnabled": false,
      "email": "text",
      "verificationCode": "text",
      "isAcceptingRequests": false,
      "tag": "text"
    },
    "payPalOptions": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "dateCreated": "2024-09-19T02:42:23.640Z",
      "isEnabled": false,
      "isFriendsAndFamilyEnabled": false,
      "isAcceptingRequests": false,
      "email": "text",
      "payPalEmail": "text"
    },
    "disabled": false,
    "planExpiry": "2024-09-19T02:42:23.640Z",
    "enabledCryptocurrencies": [
      "text"
    ],
    "stripeOptions": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "dateCreated": "2024-09-19T02:42:23.640Z",
      "isEnabled": false,
      "publishableKey": "text"
    },
    "ownedReferralLink": "text",
    "referralLink": "text",
    "atlasReports": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2024-09-19T02:42:23.640Z",
        "email": "text",
        "reason": "text",
        "gateway": "text",
        "reporter": "text",
        "resolved": false,
        "type": "text",
        "userId": "text"
      }
    ],
    "stripeEnabled": false,
    "apiKeyActive": false,
    "isCryptoEnabled": false,
    "isCardsToCryptoEnabled": false,
    "isSumUpEnabled": false,
    "isTazaEnabled": false,
    "refreshAt": "2024-09-19T02:42:23.640Z"
  }
}