canonical: https://jentic.com/apis/vualapp.com/vualapp

# Vualapp Vuala API

Vuala (Vualapp) API for managing invoices and webhook destinations for business card and invoice processing. The API exposes 4 endpoints secured with bearer authentication.

## For AI agents

Programmatically verify API connectivity, get the latest invoice. Covers 4 operations with bearer authentication.

## Scope

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

## Capabilities

- Verify API connectivity
- Get the latest invoice
- Register a webhook destination
- Delete a webhook destination
- Monitor Vuala API operational status and events

## Use cases

### Payments Operations

Use the Vuala API to perform payments operations programmatically. The API provides 4 endpoints covering core functionality including verify API connectivity, get the latest invoice, register a webhook destination.

Example prompt: Call GET /hello to verify API connectivity

### Automated General Management

Automate general operations by combining multiple Vuala API endpoints. Agents can get the latest invoice and then register a webhook destination in a single workflow.

Example prompt: Call GET `/zapier/latest` to get the latest invoice, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Vuala API 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 bearer tokens manually.

Example prompt: Search Jentic for 'verify API connectivity', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/hello` | Verify API connectivity |
| GET | `/zapier/latest` | Get the latest invoice |
| POST | `/zapier/new` | Register a webhook destination |
| DELETE | `/zapier/{id}` | Delete a webhook destination |

## Key resources

- **General** — Operations related to General
- **Invoices** — Operations related to Invoices
- **Webhooks** — Operations related to Webhooks

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 64 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 100 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 40 / 100
  - Agent Usability: 94 / 100
  - Security: 60 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/vualapp.com/vualapp/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the Vuala API by hand means learning its bearer token auth, pointing at the business-api.vualapp.com host, and attaching the token to every request yourself. Through Jentic you install once, import the Vuala API from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** The Vuala API puts the subscription id in the URL path (`/zapier/{id}`), so a rule can pin your agent to one subscription. You choose the operations it may call, so you can allow reading the latest data and creating a subscription while the delete operation is not included unless you add it.
- **Credential handling:** Your Vuala 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 'verify API connectivity' or 'create a new subscription', and Jentic returns the matching Vuala API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Stripe** — Alternative payments API
- **Adyen** — Alternative payments API
- **Square** — Complementary payments API
- **Paypal** — Complementary payments API

## FAQ

### What authentication does the Vuala API use?

The Vuala API uses a Bearer token 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 verify API connectivity with the Vuala API?

Yes. Use the GET /hello endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Vuala API?

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 verify API connectivity through Jentic?

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

### How many endpoints does the Vuala API have?

The Vuala API exposes 4 endpoints covering general, invoices, webhooks operations.

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

Yes. Because you run Jentic One yourself, your own rules decide which Vuala API operations the agent may call and which stored credential it uses. You can allow reading the latest invoice with GET `/zapier/latest` and registering a webhook destination with POST `/zapier/new` while excluding the DELETE `/zapier/{id}` operation unless you add it. Since the subscription id sits in the URL path, you can also pin the agent to a single subscription.