Account

If you wish to utilize the headless platform without using our web interface, you will require a Personal Access Token to utilize the account resources.

What is a Personal Access Token?

A Personal Access Token is a super secret token, that we allow access to certain resources that otherwise would not be accessible removing the necessity of a web interface for Yordadev's Headless eCommerce Platform. This affords you the opportunity to integrate the platform right into your existing products and or dashboards.

I accidentally leaked my Personal Access Token, help?

Sadly, there is not much we can do, as it is your responsibility to maintain operational security over your tokens, as we do while they are in our possession. However, refreshing your token before it expires will revoke the leaked Personal Access Token.

Token Life Spans

Token Type

Lifespan

Personal Access Token

1 Hour

Personal Access Refresh Token

72 Hours

Do I need to use my Personal Access Token?

The short answer is, absolutely not. You can utilize the platform's web interface instead.

Account Authorization

When required an authorization header with a Personal Access Token is to be added to all requests.

Authorization: Bearer InsertPersonalAccessTokenHere

The Personal Access Token gives the account holder to access resources within the permission scope of the token. This token is utilized to authenticate a request to the resource.

Operational Security Notice

This token is very sensitive and you should NEVER disclose or use it in public.

post
Retrieving your Personal Access Token

https://yorauth.yordadev.network/v1/account/login
This endpoint allows you to authenticate with our platform to receive Personal Access Token and a Refresh Token.
Request
Response
Request
Form Data Parameters
email
required
string
The email associated with your account.
password
required
string
The password associated with your account.
Response
200: OK
Successfully Authenticated.
{
"status": 200,
"payload": {
"name": "Yorda",
"expires": 1576204428,
"token": "eyJpdiI6IlZuQUVDeDQzalQ4a0Z4R3pWbERJS1E9PSIsInZhbHVlIjoieWh6W",
"refresh": "eyJpdiI6IkxPbXRBbGs5QVBhUjM0Z3l1Sk42eHc9PSIsInZhbHVlIjoibjhifQ=="
},
"meta": {
"from": "192.168.10.1",
"agent": "PostmanRuntime/7.22.0",
"origin": null
}
}

post
Refreshing your Personal Access Token

https://yorauth.yordadev.network/v1/account/refresh
Refresh expired Personal Access Tokens.
Request
Response
Request
Headers
Authorization
required
string
Your Personal Access Token
Form Data Parameters
token
required
string
Your Personal Access Token
refresh_token
required
string
Your Refresh Token
Response
200: OK
{
"status": 201,
"payload": {
"name": "Yorda",
"expires": 1576204428,
"token": "eyJpdiI6IlZuQUVDeDQzalQ4a0Z4R3pWbERJS1E9PSIsInZhbHVlIjoieWh6W",
"refresh": "eyJpdiI6IkxPbXRBbGs5QVBhUjM0Z3l1Sk42eHc9PSIsInZhbHVlIjoibjhifQ=="
},
"meta": {
"from": "192.168.10.1",
"agent": "PostmanRuntime/7.22.0",
"origin": null
}
}