Yordadev Docs
Yordadev Docs
Headless eCommerce Solution
General Topics
The Basics
Requesting Access
Resource Permissions
Content Formating
OAuth Service
Account
Shop
Customer
API Reference
Account Service
Shop Service
Vendor Service
Gateway Service
Powered by GitBook

Shop

To utilize our Shop resources, you will require a Client Credential Token or a Implicit Token generated by the shop, utilizing your shop secret.

What are these Shop Tokens?

We utilize OAuth concepts and restrict access to our resources by grant type. There are two type of token's to be generated on our platform to utilize your shop resources.

Shop Client Credential Access Token

The Client Credentials grant type is used by Shops to obtain an access token outside of the context of a user consuming your Shop. This is typically used on the server side of operations, and kept hidden from the public as the Client Credential token can write to your Shop's resources

Shop Implicit Access Token

The Implicit token is generally for client side access to read resources. For example, you may use a Implicit access token on the client side to grab a list of products. Ideally, any Shop endpoint that has a GET method will be accessible via Implicit tokens.

post
Issue Shop Tokens

https://yorauth.yordadev.network/v1/shop
This endpoint allows you to issue out Client Credential and Implicit tokens.
Request
Response
Request
Headers
Authorization
required
string
Your Personal Access Token
Form Data Parameters
shop_id
required
string
The shop_id of the desired shop.
shop_secret
required
string
The desired shop's secret.
grant_type
required
string
Either client_credential or implicit
Response
201: Created
Token Successfully Issued
{
    "status": 201,
    "payload": {
        "shop": {
            "shop_id": "5de85a2d0f548",
            "name": "Yorda Domains",
            "descrption": "Get yor domains. ezpz lemon squeezy."
        },
        "tokens": {
            "grant_type": "implicit",
            "token": "eyJpdiI6Ijk4Q09jbktJcEREZDlkYlJDNGlrZkE9PSIsInZhbHVlIjoiZ2VkaldcL0h3cmY2ZTljdnFTUHlcL1ZLdDBrZlNFNE9yU2txaFZWWlhhekJ2cW5nXC9HVldiZWw2VlJVOUJNRWswUXUyc0dJV0I4NVpkQkFzd2VlcW1LTkRNVkdyUldmR3ZHellsc0RweFZVeWM9IiwibWFjIjoiZTk0Yzk0NjIwMDNhYmMxNjFiNWNjN2UxNGUzODgzZDE4YmI4YTFkMjI4YjkxZWNmNzc1YTA5NDhhNTU3ZDBkMSJ9",
            "refresh_token": "eyJpdiI6IkM4Zmx5U0V4VmQ0aVZYZ0RIK0xERkE9PSIsInZhbHVlIjoiN0Vya3loZnN5NTh6QWRET1NmRUF1U2lEZDl1QzQzcDBReU9PdCtXcDJVNFd1MitOaE15OUMxRnZYeVBOcmp3OHBkMytEQzZuYVhQcGhFXC81bk5Jeno3RnhwcWdmV2FmUnRKYTI4WHdcLzJranl6M3JYc21GWkF6WkUwMGQwN3Vwc1lwVlR3cWVHN1oxRXdcL2QxZnMwQ3NGOThUSlNqWnFYRTZMK2NkbWpJUm9XeEM4XC9jeEtDSzJybEFpeVBjMzhlN2h6WW5DRHlFUnlpdWk0UEFXSzlUejh0S2ZvaEkrMnVBeUJTRHdhVFBZbUFBRkdmU2JaaVE3ZUZLZjZUTmM2MjRCV3ZyNWp2RlFERmhaTGYxNHVSRjREWjFBRk4xanY4dEZraWFVbE5RdkROTk1WczNXUnNUVWh0NDU3RlB5NW5qQzdxM0d0SWphQW5nNGJvU0ZTSDJPXC9PK2VleUtCMVZnd1VoaVRaOW13bXNhUG5Zb3J4QWNkcUhBUEtMYUwxZHVVUHFWZlpxRkNVU0ZtMnBITVo2UTFcL1Rab0NTeUEyeHo3YTZWVFFjWG94SHE3U2YrcmRyb2VtRzBSZGl2ZVBwZ0duRTVcL0pmSHA2WXBTSlp5bkVtUkxzTHp0ZjZGalBUallQV21BZkJiSlhcL08rcDlxVCs5WVhVdm9ZaVhwVUFORUdreE1aWHY3MU14aVN0eDVBSXc1VExHSjE3MWdFNmJONnZuSHRHb1Zqc2VPY0ZjaFdxUnFlckNrNmc3VXRxNFQ2K3hmWUM5SzZnQjdqM0lhM1wvZkpTQUIrQXNuZkdMbkdsOGcxcVZ1SURUcz0iLCJtYWMiOiI3MDU5ZGNmNDA5YTllODExZjlhODZiYjBlY2M2NGQ5ZGRmMWIxYTJlNmEzMmMzMjBmMjg1MWU5NzFiZTRmNTU3In0=",
            "expires": 1580868148
        }
    },
    "meta": {
        "from": "192.168.10.1",
        "agent": "PostmanRuntime/7.22.0",
        "origin": null
    }
}

put
Refreshing Shop Tokens

https://yorauth.yordadev.network/v1/shop
This endpoint allows you to refresh Client Credential and Implicit tokens.
Request
Response
Request
Headers
Authorization
optional
string
Your Personal Access Token
Form Data Parameters
shop_id
required
string
The shop_id to which the token's belong
grant_type
required
string
The grant_type of the token
token
required
string
The expired token
refresh_token
required
string
The refresh token
Response
200: OK
​

get
Fetching Shop(s) Tokens

https://yorauth.yordadev.network/v1/shop
This endpoint allows you to get all of your active shop tokens.
Request
Response
Request
Headers
Authorization
required
string
Your Personal Access Token
Query Parameters
shop_id
optional
string
The desired shop's shop_id
Response
200: OK
Successfully receiving active tokens.
{
    "status": 200,
    "payload": {
        "client_credentials": [
            {
                "reference": "restful-api",
                "token": "eyJpdiI6IjJEdmR3K3c0dmJxaFpOa1ZUbFh6Q2hVNWVhY3p4ZnV3M3o3K0VraXVlaml2RVNzVFhBamlIRDhWejhJRzArMjRkbkNkcW1CRjJQT3hObmJnMlwvTHJNQ2pzTlQwWFM4RG1zVUppakhzcGE3YXJoNzNGMjMxR1BYeUJJYUQ1eWR3U1pQVVwvN0xkSSt4MGxyY1B6MDIzejdtdzIzajdrNHgrZ3h2eXBnKzlEN0ZxWXpwTFJoaGhsUDlQMmtyOGJtbnczTGRkSzJsVVBFUWZwS2pUcVBMeW5nMVo3TDVNeXB3WFwvcktpNmxJaVlDNmhHZUhpQTNMc0lmSmRXY09UNHJ0V3RZSmlhT2JmTHNaSCtQb3pxNVJlMnpsUkJqak1DNTB5MmNKZ0luUXM0aWw2WUJkYXo2ejg9IiwibWFjIjoiNDU3NDQ1YjI3Y2YwNjYxOTNjMmJlYWZkN2M2NmJmNDk3NzgwMmViNjlhMjM0ZjdlMzZmN2I5ZjkyZDVlOTRjNSJ9",
                "refresh_token": "eyJpdiI6IitIeCtVWStDRys3sInZhbHVlIjoiaUVQVmYxbnpicWY1MjNsM1p0VFZ6eXRJeEVWejJZdXpXaGVWUHBBZjI4ZlZiOE1aZFhkVmtkbEZhYTkyUStzc3NSdTBCaCthN1FSN0dseVVGdEtuTW9yUnV3K1FnOFFBSmtITjdHWVdWZk1KXC9IcThqK3hETm5OTFVoUENpenU0UVN1K2lhaTBwRnZ5RUFjc2NUS2t4OFwvUk15Mm4xWW9oNCtGSGQ1NE9PRE1lWm42Yk5CRWljXC8zYThjcWl1YmRON2d6ZFpcL2tLdzVQdWJzQVB1VDVMWVBtaXRuUUtDczNcLzVlNUpKd0NDMFpaZ1wvTHhJT3krSCtSdDk5KzFTS1dBZlE1NkNiMVBcL3VQOGUwSWx5Nit0WVYyXC9wUWw2eW5BNW5pSWNra2JxZ1FlUWU0bXVzWmFYNWNGcXNZTVgzU3dvdVRsWTIrOVd2amZXZHR2dzNFV1E2OGgyRWNsUWdKU2VqcjJRUlBCeHloZVwvTWZ0UTZwa2JEb3hBa0hmWXBLZmxUSzB0c2NVR25xdXdtOW9DbEo3SVJMSWZoTkdhWGhZYWFRTWt6U1RGbUtUMWVzaHlEZ2pkZjZTZ2ppbXVBM1F0TEdseHI4amtwUVwvclpnSnZkNFwvT1llOVNMeWR4RXk5T0dcL1huTHRzUU02RGZjQm12UUZLXC84bGhGSU1jWTRrXC9cL2Rqd1wvXC9OalozTTZkVU1waU5weFNpVlwvNUZuclMxM2V3alhETDFYWGttbjQwaUY0ZTFsRG1GZCsxRDJkMjNIV24xTmNLU3VcL2RJUDR6XC9hZFJ3dElLRzZGWjNENjY1TnZkV2w5XC82UE1yK2M3RzZUYldvbWdrNjh6TjR0em1WN1RYM2R2K1ZlWnorSlZcL1lxaHdyTnluQWpPaFM5ZWN1MzJTQ1NMZmdaYnJOQkNKb3pzc2FNM2tlVlUrYXB0b1gyODkydDNzSEM2RW4zeld1UElDYjlXZ2F2eG9sUnhOZGxsczM5ODdpNk1qbFJRaGpuS1F0MXpDaU83N0J0T1R6RWxaVmtyZlZKd0t4ZSs1ZWpLekdYaEp1ODBFaHBxaGlHcDZcL3lHUmNrODVBR3JrSkI4cFFMUnRPWjJkWXRWWFdNbndWT0R1T0FMcGNCQ1BFUFVlbHVWNDJZZmhNaWpPTFdVT0dSME9md0RPSEQ0dEVKS3B2dzBOSkplQzBpbzdlaEtWVTBHcVhhbEF1c3EyQ2ZNR044ZGxibVJqekV2UXpiVEVoWTRuS2ViOU9TSmlIWVNQRkY5RXhVVkN0eXVcL3NjeVwvM2ZmcHVkZFZYYlhEeEMyNndOUHo5QW81emtBNDR1VnoybDRrdGN4Q1wvbVQ3aVVsTm1nbzhQODNIc2ZwUGRBV2M2U2JpcVUyS1pteis0S3RqczVidnNpS05cL050Q2Z4aXJnWHNucE4zVmIzUVU9IiwibWFjIjoiYTQxNTFjNDlhMjM3MTFiODNhNmU4MjRmOWU1NmZiYWEzYzIxOGRlZTEzZTE5NzBiNmY4YjNmOGVjMTRlNTYwNSJ9",
                "expires": "1576204810",
                "created": "2019-12-10T19:40:10.000000Z"
            }
        ],
        "implicit": [
            {
                "reference": "webstore",
                "token": "eyJpdiI6IkRzWjJ5Tituc1BWMzRsNVdIjoiODFveXpvYllBVTBwTXpIcEFJRHUwTm4yZnZqQVlCSUk4UWxGZ25GZlVDT1o3ZnlEekQrTlc1WHZ3N0wydHlkWjY2XC9WakR2b0xFaWo4VldpaEZNNzZNbUc1cnp1TXBWYzhqTTRHdElxV1ZrPSIsIm1hYyI6ImQ5NTIwNDc5M2IwZDVmZmQyN2Y1ZmVjYWNlMzVjYjM5ODY5ZGM4ZWUzZDAzOTlkZjVlY2MyMWI4N2MzMGU1NDcifQ==",
                "refresh_token": "eyJpdiI6IlY1djh0Zkd5WkNmZhbHVlIjoiM01uTnU5REx5NXo1SUtFTEpEK1pMb2dqK1hjK1BBTGIrQnZoemo4VlB2dHg5WkJRQnJ1a2pNdjlLdTY2RGVkUXBsMlJPMFFUbzNUTjU4S2FiTWdpRzA4NXhKN1V4cHdDUFpGSXhWQjJGNTFLU25ka3pudUE2RmRoM0dSU3paaFp1XC91ZlRaYkJ3NW5EMVdSQkEraVwvT2pvMXBCZ3kwVTZQUWVSZ3N5YmlFZ1RYZzRvQTV4dkNwS2hPaUh1czYwV3hoREJnRHRzTVo0dTQrQ2VyczViUWw0eWpJcU9QRDE4NGFBV1hlRnFJWkIwVTdKQWJzSFQ4bU1cL09IVlZlTTFxbUtieXM5d3ZvUnVZQlQ2bURLcnFoZTJ6dEMrbVpqbmQ3Q3dvSVZiMHVwVlgxNDYrUzlFcDRpaFhvSEhUdzRiOUt0elhJRHJFbTNBb0pjYzJScU5BMnExaHJQZ1RwQ2dGbVpzeVdnY1YzeFVQc040YmtpWEZUVGNcL3BFMmtSRTlMdHVXeDJyUlJCRkJHckIwUDRnMXpTNW8zanZIOG8wS2FJZTJCVkh2dmR0ejRQRk9Bdld1dk9aNlRRSmdUTG1PV29ZWmNuOGYra25EMWhNM1FtT1NZenhwbml1OHpiaUEzNUxwS1Jic0VtXC9vNWtOWUU3dlBRUHRtRGRBWDlEQUtIVUFBbnlaNWkrUkZCTHRuNndhZ2FvMEVnbzdsOFZTXC9RcG9EaEUwb3haUzRcL0taNmZOczYxb2RBdHVoZkxxWnN6SlkzcGducGRSQUZjakliUDl5ZkxYYU9jU3piRTFGQ2x3SnlYSWVaZVV6REE9IiwibWFjIjoiMzQ5ZDM2MmNjMzE1MmJmY2VhMzc2NTFjMjQxNDgwODllNmZiNjE4ZDhjZDY2YzNmZmM3MjA4N2M3ODk2ZDBjNCJ9",
                "expires": "1576215640",
                "created": "2019-12-10T19:40:10.000000Z"
            },
            {
                "reference": "mobile-app",
                "token": "eyJpdiI6Ijk4Q09jbktJcEIsInZhbHVlIjoiZ2VkaldcL0h3cmY2ZTljdnFTUHlcL1ZLdDBrZlNFNE9yU2txaFZWWlhhekJ2cW5nXC9HVldiZWw2VlJVOUJNRWswUXUyc0dJV0I4NVpkQkFzd2VlcW1LTkRNVkdyUldmR3ZHellsc0RweFZVeWM9IiwibWFjIjoiZTk0Yzk0NjIwMDNhYmMxNjFiNWNjN2UxNGUzODgzZDE4YmI4YTFkMjI4YjkxZWNmNzc1YTA5NDhhNTU3ZDBkMSJ9",
                "refresh_token": "eyJpdiI6IkM4Zmx5IsInZhbHVlIjoiN0Vya3loZnN5NTh6QWRET1NmRUF1U2lEZDl1QzQzcDBReU9PdCtXcDJVNFd1MitOaE15OUMxRnZYeVBOcmp3OHBkMytEQzZuYVhQcGhFXC81bk5Jeno3RnhwcWdmV2FmUnRKYTI4WHdcLzJranl6M3JYc21GWkF6WkUwMGQwN3Vwc1lwVlR3cWVHN1oxRXdcL2QxZnMwQ3NGOThUSlNqWnFYRTZMK2NkbWpJUm9XeEM4XC9jeEtDSzJybEFpeVBjMzhlN2h6WW5DRHlFUnlpdWk0UEFXSzlUejh0S2ZvaEkrMnVBeUJTRHdhVFBZbUFBRkdmU2JaaVE3ZUZLZjZUTmM2MjRCV3ZyNWp2RlFERmhaTGYxNHVSRjREWjFBRk4xanY4dEZraWFVbE5RdkROTk1WczNXUnNUVWh0NDU3RlB5NW5qQzdxM0d0SWphQW5nNGJvU0ZTSDJPXC9PK2VleUtCMVZnd1VoaVRaOW13bXNhUG5Zb3J4QWNkcUhBUEtMYUwxZHVVUHFWZlpxRkNVU0ZtMnBITVo2UTFcL1Rab0NTeUEyeHo3YTZWVFFjWG94SHE3U2YrcmRyb2VtRzBSZGl2ZVBwZ0duRTVcL0pmSHA2WXBTSlp5bkVtUkxzTHp0ZjZGalBUallQV21BZkJiSlhcL08rcDlxVCs5WVhVdm9ZaVhwVUFORUdreE1aWHY3MU14aVN0eDVBSXc1VExHSjE3MWdFNmJONnZuSHRHb1Zqc2VPY0ZjaFdxUnFlckNrNmc3VXRxNFQ2K3hmWUM5SzZnQjdqM0lhM1wvZkpTQUIrQXNuZkdMbkdsOGcxcVZ1SURUcz0iLCJtYWMiOiI3MDU5ZGNmNDA5YTllODExZjlhODZiYjBlY2M2NGQ5ZGRmMWIxYTJlNmEzMmMzMjBmMjg1MWU5NzFiZTRmNTU3In0=",
                "expires": "1580868148",
                "created": "2020-02-05T01:02:29.000000Z"
            }
        ]
    },
    "meta": {
        "from": "192.168.10.1",
        "agent": "PostmanRuntime/7.22.0",
        "origin": null
    }
}

delete
Revoking a Shop Token

https://yorauth.yordadev.network/v1/shop
This endpoint allows you to revoke a shop access token.
Request
Response
Request
Headers
Authorization
required
string
Your Personal Access Token
Query Parameters
shop_id
required
string
The desired shop_id
grant_type
required
string
The grant type of the given token
token
required
string
The desired token to be revoked
Response
200: OK
​
Previous
Account
Next
Customer
Last updated 1 month ago
Contents
What are these Shop Tokens?
Shop Client Credential Access Token
Shop Implicit Access Token
post
Issue Shop Tokens
put
Refreshing Shop Tokens
get
Fetching Shop(s) Tokens
delete
Revoking a Shop Token