APIX Documentation

website·Indexed 30 days ago

https://docs.apix.vn

Documentation for the APIX marketplace, providing guides for API providers to list products, configure base URLs and endpoints, and set pricing plans. It also includes instructions for consumers to discover APIs, manage subscriptions, and handle deposits via methods like VNPay QR.

Tokens
7.9K
Snippets
11
Records
75
Agent score
48%

What's inside APIX

  1. Manage API subscription plans and quotas

    APIs in the marketplace offer various subscription plans with different quotas and rate limits. Most providers offer a free basic plan that allows developers to test the API before upgrading to a paid plan.
  2. Understand Apix.vn payment security and data handling

    Apix.vn ensures payment security by partnering with licensed payment gateways (such as VNPAY) that comply with industry security standards, including the PCI Security Standards Council.

    Key security measures include:

    • Data Encryption: Financial information is protected during transactions using SSL (Secure Sockets Layer) and 128-bit MD5 encryption.
    • Authentication: One-Time Passwords (OTP) are sent via SMS to authenticate account access.
    • Compliance: Adheres to information security regulations for the banking and financial industry as mandated by the State Bank of Vietnam.

    Data Storage Policy:

    • Card Information: Apix.vn does not directly store customer card information. For international cards, all sensitive transaction data is stored and secured by the licensed Payment Gateway partner.
    • Tokenization: Apix.vn utilizes a token storage utility, storing only the encrypted strings provided by the Payment Gateway partner.
    • Domestic Cards (Internet Banking): Apix.vn only stores the order code, transaction code, and the name of the bank.
  3. Track API quota and expiration via response headers

    The API response headers provide real-time information about your usage limits:

    • x-dmp-quota: The number of remaining requests in your current plan.
    • x-dmp-ttl: The time remaining until the plan expires, measured in seconds.
  4. Manage API subscription plans and quotas

    APIs offer various subscription plans with different quotas and rate limits. Most APIs provide a free basic plan allowing developers to test the provider's API before upgrading to a paid plan.
  5. Understand Apix.vn Partnership Terms

    Apix.vn provides API services to partners (individuals or organizations). Partnership is established when a user agrees to the General Terms and is approved as a member. The partnership remains active until the account is locked, suspended, or the Apix system ceases operation. Partners may acquire API services via listed packages, renewals of existing packages, or direct proposals from Apix.vn.
  6. Choose an API cooperation model on Apix.vn

    Partners can engage with Apix.vn through three primary cooperation forms:

    1. Purchasing API packages listed directly on the Apix.vn website.
    2. Renewing existing packages already used on the system.
    3. Purchasing recommended packages directly through Apix.vn.
  7. Update, delete, or request your personal data from APIX

    Users can manage their personal information through the following methods:

    • Updating/Editing: Log into the online account to modify information or send an email to support@Apix.vn.
    • Account Deactivation: Send an email request to support@Apix.vn. Note that some data may be retained for legal or legitimate business purposes.
    • Data Access Requests: Contact support@apix.vn to find out if APIX holds or processes your personal data. APIX aims to respond to access requests within 30 days.
  8. Find and explore APIs on the platform

    To find an API for your application, navigate to the API section from the landing page navigation bar. This opens a listing of all public APIs. Each API page contains a Playground tab providing endpoints, parameters, and multi-language code snippets for integration, as well as Introduction, Tutorial, and Discussion tabs for additional documentation.
  9. Understand Apix.vn payment security and data storage

    Apix.vn ensures payment security by partnering with licensed payment gateways (such as VNPAY) that comply with PCI Security Standards Council requirements. Apix.vn does not directly store sensitive customer card information; instead, it uses a token storage facility to store only the encrypted strings provided by the payment gateway partner.

    Data storage specifics:

    • International Cards: Card information used for transactions is stored and secured by the Payment Gateway Partner, not on Apix.vn systems.
    • Domestic Cards (Internet Banking): Apix.vn only stores the order code, transaction code, and bank name.
    • Security Measures: Transactions are protected using SSL (Secure Sockets Layer), 128-bit MD5 encryption, and OTP (One-Time Password) via SMS for account authentication, adhering to State Bank of Vietnam regulations.
  10. Deposit funds into APIX account balance

    To deposit funds into your APIX account, follow these steps:

    1. Log in to your account.
    2. Navigate to the Consumers tab and select Balance.
    3. Enter the amount you wish to deposit.
    4. Select a preferred payment method. APIX supports the following options:
      • MoMo e-wallet
      • ZaloPay e-wallet
      • ShopeePay e-wallet
      • VNPay (ATM card, Credit card, Debit card, or VNPay QR)
    5. Click Agree to proceed with the payment.
  11. Cancel an API subscription

    Buyers can terminate their API subscription at any time by selecting 'Cancel Subscription' on the applicable API plan page. Note that APIX does not issue refunds for packages that have been canceled but have not yet expired.
  12. Deposit funds into APIX buyer account

    To deposit funds into your APIX account, follow these steps:

    1. Log in to your account.
    2. Navigate to the Buyer (Người mua) page and go to the Balance (Số dư) section.
    3. Enter the amount you wish to deposit.
    4. Select a payment method. APIX supports the following options:
      • MoMo E-wallet
      • ZaloPay E-wallet
      • ShopeePay E-wallet
      • VNPay System (ATM cards, Credit cards, Debit cards, or VNPay QR)
    5. Click on your preferred payment method and select Agree (Đồng ý) to proceed.