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

# TDox Web Services API

TDox turns business processes and paper forms into mobile apps. The designer allows creating forms, which are filled in using the mobile app. This API provides access to manage centers, customers, documents, products, and agenda items. The API exposes 18 endpoints secured with apiKey authentication.

## For AI agents

Programmatically check authentication token, insert or update a customer. Covers 18 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for e-commerce only.

## Capabilities

- Check authentication token
- Insert or update a customer
- Search customers
- Disable a customer
- Subscribe to a document model
- Unsubscribe from a document model
- Get last instance data for a document model

## Use cases

### E-Commerce Operations

Use the TDox Web Services API to perform e commerce operations programmatically. The API provides 18 endpoints covering core functionality including check authentication token, insert or update a customer, search customers.

Example prompt: Call GET `/api/Centers/CheckToken/{token}` to check authentication token

### Automated Agenda Management

Automate agenda operations by combining multiple TDox Web Services API endpoints. Agents can insert or update a customer and then search customers in a single workflow.

Example prompt: Call POST `/api/Customers/InsertOrUpdate/{key}` to insert or update a customer, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call TDox Web Services 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 apiKey tokens manually.

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

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/api/Centers/CheckToken/{token}` | Check authentication token |
| POST | `/api/Customers/InsertOrUpdate/{key}` | Insert or update a customer |
| POST | `/api/Customers/Search` | Search customers |
| POST | `/api/Customers/Disable` | Disable a customer |
| POST | `/api/Documents/Subscribe/{idModel}` | Subscribe to a document model |
| POST | `/api/Documents/Unsubscribe/{idModel}` | Unsubscribe from a document model |
| GET | `/api/Documents/GetLastInstanceData/{idModel}` | Get last instance data for a document model |
| GET | `/api/Documents/GetDownloadId/{instance}` | Get download ID for a document instance |

## Key resources

- **Agenda** — Operations for Agenda
- **Centers** — Operations for Centers
- **Customers** — Operations for Customers
- **Documents** — Operations for Documents
- **Products** — Operations for Products

## 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:** 63 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 90 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 48 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 58 / 100
- **View full report:** https://jentic.com/apis/tdox.com/tdox/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 TDox Web Services API by hand means sending your token in the Authorization header, targeting the tdox-webapi-public.azurewebsites.net host, and building your own retry handling across its customer and document endpoints. Through Jentic you install once, import the TDox Web Services API from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** The TDox Web Services API puts the model id in the URL path (`/api/Documents/Subscribe/{idModel}`, `/api/Documents/GetLastInstanceData/{idModel}`), so a rule can pin your agent to one document model: it can read its last instance data. You choose the operations it may call, so state changes like subscribing, unsubscribing, or disabling a customer are not included unless you add them.
- **Credential handling:** Your TDox 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 'check an authentication token' or 'get the last document instance data', and Jentic returns the matching TDox Web Services API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Shopify** — Alternative e commerce API
- **Stripe** — Alternative e commerce API

## FAQ

### What authentication does the TDox Web Services API use?

The TDox Web Services API 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 check authentication token with the TDox Web Services API?

Yes. Use the GET `/api/Centers/CheckToken/{token}` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the TDox Web Services 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 check authentication token through Jentic?

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

### How many endpoints does the TDox Web Services API have?

The TDox Web Services API exposes 18 endpoints covering agenda, centers, customers operations.

### Can I limit what my agent is allowed to do with the TDox Web Services API?

Yes. Because you run Jentic One yourself and your own rules decide which operations and credentials the agent may use, you pick exactly which TDox operations it can call. Since the document model id sits in the URL path, you can pin the agent to a single model and grant only read access, such as GET `/api/Documents/GetLastInstanceData/{idModel}.` State changes like POST `/api/Documents/Subscribe/{idModel}`, unsubscribing, or POST `/api/Customers/Disable` stay off limits unless you add them.