This page will help you get started with OnRamp API.
To start using the OnRamp API, a Vendor Admin needs to login to OnRamp by visiting https://app.onramp.us and retrieving your organization's OnRamp API Key from the Settings Page.
Once you have this key, you'll use it to Authenticate with the OnRamp API to create a session with our /authenticate endpoint.
curl --request POST \
--url http://api.onramp.us/v1/auth \
--header 'Content-Type: application/json' \
--data '{
"token": "Aiacyw8MCHX-oQqSX9O1pw"
}'
Which will return a Session ID which will be valid for 5 minutes.
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE2NTE0ODUzMDUsImlhdCI6MTY1MTQ4MjMwNSwic3ViIjoiZmE2ZjhhZGMtY2I2MS00MzcyLWJiMGItMjU2MWZhMTcxNTk2In0.Cb402Vj5YO05YYkOMhbQCX_ahZ0okXlF206T8DfwXNs
Now that you have your Session ID, you can begin to call the OnRamp API Endpoints. An example would be to call the List Projects endpoint.
curl --request GET \
--url http://api.onramp.us/v1/projects \
--header 'Accept: application/json' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE2NTE0ODUzMDUsImlhdCI6MTY1MTQ4MjMwNSwic3ViIjoiZmE2ZjhhZGMtY2I2MS00MzcyLWJiMGItMjU2MWZhMTcxNTk2In0.Cb402Vj5YO05YYkOMhbQCX_ahZ0okXlF206T8DfwXNs' \
--header 'Content-Type: text/plain'
Which might return a response such as
{
"projects": [
{
"account": {
"id": "PQZOpnel5aKBzyVX",
"logo_path": "https://app.onramp.us/static/img/logos/2be49d95-blob",
"name": "Boeing1"
},
"id": "QABWJxbo2jagwOL0",
"is_overdue": true,
"name": "asdasd",
"percentage": 0,
"performance": "GREEN",
"project_owner": {
"email_address": "[email protected]",
"full_name": "Ross Lerner",
"id": "rm0wMvbmOeYAlO1n",
"profile_pic": null
},
"project_state": "Active",
"start_date": "2021-03-19"
},
{
"account": {
"id": "PQZOpnel5aKBzyVX",
"logo_path": "https://app.onramp.us/static/img/logos/2be49d95-blob",
"name": "Boeing1"
},
"id": "VvJ4open5Rd7Az1X",
"is_overdue": true,
"name": "gfh",
"percentage": 0,
"performance": "GREEN",
"project_owner": {
"email_address": "[email protected]",
"full_name": "Ross Lerner",
"id": "rm0wMvbmOeYAlO1n",
"profile_pic": null
},
"project_state": "Active",
"start_date": "2021-03-19"
}
]
}