canonical: https://jentic.com/apis/swaggerhub.visanetperu/api-niubiz-ecommerce

# Visanetperu API Niubiz eCommerce

API encargada de la operatividad via comercio electronico. The API exposes 24 endpoints secured with apiKey authentication.

## For AI agents

Programmatically remove card token, remove card token. Covers 24 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for developer tools only.

## Capabilities

- Remove Card Token
- Retrieve Token List
- Get Client Ip
- Query and filter API Niubiz eCommerce records by parameters
- Monitor API Niubiz eCommerce operational status and events

## Use cases

### Developer Tools Operations

Use the API Niubiz eCommerce to perform developer tools operations programmatically. The API provides 24 endpoints covering core functionality including remove card token, remove card token, retrieve token list.

Example prompt: Call POST /card/management/remove/{vault} to remove card token

### Automated API to get client Ip Management

Automate API to get client ip operations by combining multiple API Niubiz eCommerce endpoints. Agents can remove card token and then retrieve token list in a single workflow.

Example prompt: Call POST /card/management/remove/{vault}/{block}/{attribute} to remove card token, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call API Niubiz eCommerce endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'remove card token', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | /card/management/remove/{vault} | Remove Card Token |
| POST | /card/management/remove/{vault}/{block}/{attribute} | Remove Card Token |
| GET | /card/management/retrieve/filter/{vault}/eblock/{block} | Retrieve Token List |
| GET | /card/management/retrieve/filter/{vault}/{block} | Retrieve Token List |
| GET | /card/management/retrieve/{vault}/eblock/{block} | Retrieve Token List |
| GET | /card/management/retrieve/{vault}/{block} | Retrieve Token List |
| GET | /clientip | Get Client Ip |
| POST | /configuration/merchant/management/{entityId} | Create/Update Merchant Configuration |

## Key resources

- **Api to get client Ip** — Api to get client Ip
- **Api to manage tokenized cards** — Api which manage tokenized cards
- **Card Bin Additional Information** — Query in order to retrieve card bin additional information
- **Create Session Token** — RESTful API to create a session token.
- **Dynamic Currency Conversion** — Query the eligibility of a card to use DCC

## Why Jentic

- **Setup:** Wiring the API Niubiz eCommerce by hand means obtaining an access token from Niubiz api.security, passing it in the Authorization header, and coding its card-management and configuration calls against its vnforapps.com host yourself. Through Jentic you install once, import the API Niubiz eCommerce from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** The API Niubiz eCommerce puts the vault id in the URL path (/card/management/retrieve/{vault}/{block}), so a rule can pin your agent to one vault: it can retrieve stored card blocks for that vault. You choose the operations it may call, so a destructive one like removing a card with POST /card/management/remove/{vault} is not included unless you add it.
- **Credential handling:** Your Niubiz access token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'retrieve a stored card token from a vault' or 'get the client IP', and Jentic returns the matching API Niubiz eCommerce operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Github** — Alternative developer tools API
- **Gitlab** — Alternative developer tools API

## FAQ

### What authentication does the API Niubiz eCommerce use?

The API Niubiz eCommerce uses an API key passed in the `Authorization` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I remove card token with the API Niubiz eCommerce?

Yes. Use the POST /card/management/remove/{vault} endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the API Niubiz eCommerce?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I remove card token through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'remove card token'. Jentic returns the matching API Niubiz eCommerce operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the API Niubiz eCommerce have?

The API Niubiz eCommerce exposes 24 endpoints covering API to get client ip, API to manage tokenized cards, card bin additional information operations.

### Can I limit what my agent is allowed to do with the API Niubiz eCommerce?

Yes. Because you self-host Jentic One, your own rules decide which API Niubiz eCommerce operations and credentials the agent may use, so you can allow a read-only path like GET /card/management/retrieve/{vault}/{block} while withholding a destructive one such as POST /card/management/remove/{vault}. Since the vault id sits in the URL path, a rule can pin the agent to a single vault, letting it retrieve stored card blocks only for that vault. The agent can reach an operation only when you add it to the allowed set, and the Niubiz access token stays encrypted in your own instance and is injected at execution time rather than exposed to the agent.