Meal Plans & Account Balances Exp API

Meal Plans & Account Balances Exp API

The NYU Meal Plans & Account Balances API provides programmatic access to meal and account balance data from the OneCard system (Atrium). Key features include:

• Meal Balances: Retrieve the number of remaining meals available.
• Account Balances: Access remaining balances in Dining Dollars and Flex Dollars.

Please note:

• USD balances are represented in cents.

• AED balances are represented in fils.

• MEL (Meal) currency represents meals remaining.

This API facilitates seamless integration with campus dining and financial systems, ensuring accurate and up-to-date information for users.

Data Refresh Frequency: Real Time data from OneCard System.

Requesting API Access

Access to this API is strictly governed by the respective data stewards; all access requests require their approval. Please note that there are multiple steps to gain access to this API, and they need to be followed in order.

1. If you don’t already have one, request a Service Account/Special Purpose ID from Identity Data Services.

   • Request a Service Account/Special Purpose ID
   • Be sure to review: Policy on Accounts (NetIDs, Special-purpose NetIDs, Privileged Access Accounts) and Access (MFA, Passwords)

2. Submit an API access request via https://dataaccess.it.nyu.edu (VPN is required off-campus).

   • Note: As part of this access request, you need to identify the Service Account/Special Purpose ID that will be used to access the API. If you don’t already have one, please go back to Step 1.
   • Click on “API Access Form” and fill out the form to the best of your knowledge.
   • See also: NYU APIs Governance Workflow (API Access Request) (VPN is required off-campus).

3. Complete the review process.

   • Architecture Review Board (ARB) Review: After receiving your request, you’ll be contacted to schedule an ARB Review meeting. During this review, the ARB will evaluate your technical implementation to ensure it meets technology requirements and security standards. This step includes preparing a set of supporting documents that will be used for final Data Steward Approval. Expect this process to take approximately two to three weeks.
   • Data Steward Approval: Upon completion of the ARB Review, your request will be forwarded to the Data Stewards for final approval.

4. Log in with the Service Account.

   • Upon completion and approval of your API access request, log out of this API portal and log back in using the Service Account/Special Purpose ID specified in the API access form.
   • Click the "Request Access" button in the top right corner of this page.
   • Create a new application and name it to reflect your client application in a way that is identifiable to the API team (please avoid using spaces or special characters).
   • Once the application is created and the access request is submitted, you will receive a client_id and client_secret.
   • See also: Connecting to APIs.

5. Obtain an OAuth 2.0 Access Token:

   • Follow the instructions to obtain an OAuth 2.0 access token.
   • API Token Generation (VPN is required off-campus).

Estimated API Access Approval Time: requests typically take 3–6 weeks to complete. Some requests may take longer based on specific requirements or external factors.

API Support

• For more information on APIs, tools, testing, and other resources, please refer to the NYU Developer Portal (VPN is required off-campus).
• For troubleshooting assistance with using the API, please email the API Services Team.