🔑 Authentication

Get started with accessing your widget.

To instantiate your widget you should create an accessToken and pass this as a URL parameter in your widget.

You'll need to use the api key and the secret key generated for you in the dashboard.

Environment	Base URL
Dev	https://apiv2-dev.rampnalysis.com/
Prod	https://apiv2.rampnalysis.com/

---

Refresh Access Token

POST https://apiv2-dev.rampnalysis.com/api/rampnalysis/refresh/access_token

Creates an access token.

Headers

Name	Type	Description
api-key*	String	Api Key
secret-key*	String	Secret Key

Request Body

Name	Type	Description
expirationDays	String	One of 7, 30, 180, 365 or infinite (default: 30)

---

Get Refreshed Access Token Expire Date

GET https://apiv2-dev.rampnalysis.com/api/rampnalysis/refresh/access_token/expire_date

Query Parameters

Name	Type	Description
accessToken	String	Your refreshed accessToken

---

Your widget URL should look something like this:

https://widget-dev.rampnalysis.com/widget/?accessToken=<YOUR_ACCESS_TOKEN>

You can use this URL as a redirect or insert it into an iframe / webview.

📦 Get Your Order History and Details

Endpoint:
GET https://apiv2.rampnalysis.com/api/rampnalysis/order_history

Retrieve details of your order(s) using either the order_id, your own custom_id, or simply the accessToken to fetch all available orders.

---

🔐 Authentication

Pass a valid and refreshed accessToken as a query parameter to authenticate your request.

---

🧾 Query Parameters

Name	Type	Required	Description
accessToken	String	✅ Yes	Your valid and refreshed access token
order_id	String	❌ No	Specific order ID (usually received from webhook)
custom_id	String	❌ No	Your custom identifier provided during order creation

If order_id or custom_id is not provided, the API will return all orders associated with the authenticated user.

---

✅ Example Request

GET https://apiv2.rampnalysis.com/api/rampnalysis/order_history?accessToken=abc123xyz&order_id=ORD56789

---