NYYU Logo

API FAQs

Frequently asked questions about NYYU APIs

Frequently Asked Questions

Find answers to common questions about NYYU APIs, authentication, and integration

Getting Started

Q:How do I get started with the NYYU API?

Refer to our Getting Started guide for detailed instructions on how to use our APIs. The guide covers authentication, making your first request, and best practices.

Q:What authentication method do you use?

We use OAuth2 for authentication across all our APIs. You'll need to obtain an access token and include it in the Authorization header of your requests.

Q:What is the difference between NYYU API, NYYU PAY, and NYYU NODE?
NYYU API: Core system API based on Java Spring Boot and GraphQL for main platform functionalities
NYYU PAY: Node.js-based payment service using WebSocket for cryptocurrency payment processing
NYYU NODE: Node.js-based service supporting multiple cryptocurrencies via WebSocket (ETH, BTC, BNB, Solana, Polygon)

Authentication & Security

Q:How do I authenticate with NYYU APIs?

Obtain an OAuth2 token from your NYYU dashboard and include it in the Authorization header of your requests as Bearer YOUR_TOKEN. See the Authentication section for detailed steps.

Q:What scopes are required for accessing NYYU APIs?

Scopes depend on the specific API being accessed. Common scopes include "openid", "profile", and "email". Check the documentation for each endpoint to see required scopes.

Q:How do I handle two-factor authentication (2FA) with NYYU API?

Use the mutations for requesting and confirming 2FA setup. See Two-Factor Authentication documentation for implementation details.

API Endpoints & Usage

Q:What are the endpoints for NYYU PAY and NYYU NODE?
NYYU PAY: wss://api.pay.nyyu.io
NYYU NODE: wss://api.node.nyyu.io
Q:How do I initiate a payment using NYYU PAY?

Connect to the WebSocket endpoint wss://api.pay.nyyu.io and send a JSON message with payment details including action, amount, and currency. See our payment integration guide for code examples.

Q:How do I get the balance of a cryptocurrency using NYYU NODE?

Connect to the WebSocket endpoint and send a message with action "getBalance" and specify the currency (ETH, BTC, etc.). The response will include the current balance.

Q:What is the rate limit for NYYU APIs?

Rate limits vary by endpoint and authentication tier. Implement exponential backoff for rate-limited requests and monitor response headers for limit information.

User Management

Q:How do I update my user profile using NYYU API?

Use the appropriate GraphQL mutation to update user profile details. See User Profile documentation for available mutations and examples.

Q:How do I manage my avatar using NYYU API?

Use the provided mutations for setting and updating avatar components. See Avatar Management for detailed implementation.

Q:What is the process for verifying my account?

Follow the steps outlined in the Account Verification section, which includes sending and confirming verification codes via email or SMS.

Trading & Auctions

Q:How do I participate in an auction using NYYU API?

Use the provided mutations for placing and increasing bids. See Auction Participation for step-by-step examples and bid management.

Q:How do I retrieve notifications using NYYU API?

Use the queries provided to fetch notifications with pagination support. See Notifications for filtering and management options.

Error Handling & Support

Q:How do I handle errors returned by NYYU APIs?

Errors are returned with appropriate HTTP status codes and error messages. Always check the response status and implement proper error handling with retry logic for transient errors.

Q:What should I do if I encounter a problem with the NYYU API?

Check our troubleshooting guide for common issues and solutions. If the problem persists, contact our developer support team with your API request details and error messages.

Q:How do I get the latest updates and changes to NYYU APIs?

Refer to the Changelog section for the latest updates, changes, and deprecation notices for our APIs.

Commercial Use

Q:Can I use NYYU APIs for commercial applications?

Yes, NYYU APIs are designed to support both personal and commercial applications. Review our terms of service and pricing plans for commercial usage details.

💬
Still have questions?
Contact our developer support team or join our community forum for help