canonical: https://jentic.com/apis/efbin.org/efbin

# Efbin Eleusoft EfBin.org

Eleusoft EfBin.org is the API surface for the EFormBin platform - a server for storing, querying, and transforming structured form data, schemas, and binary attachments organised into bins. The 177-endpoint surface covers bin and bin-attribute management, bin instances, profiles, roles, users, OAuth app users, login and error logs, bookmarks, CSRF tokens, schema-from-form generation (form2schema, xsd2schema), and a Swagger admin surface. Most calls require the user to be authorised through the platform's session-based mechanism.

## For AI agents

Manage EFormBin bins, attributes, users, and schema-conversion utilities for structured form storage.

## Scope

Does not handle payment processing, identity-provider issuance, or external file storage - use for managing EFormBin bins, attributes, instances, users, logs, and schema converters only.

## Capabilities

- Manage bins and the attributes attached to them across an EFormBin server
- List, create, and inspect bin instances that hold concrete records inside a bin
- Administer users, roles, profiles, and OAuth app users for an EFormBin deployment
- Pull error-handler logs, login logs, and grabbed-URL records for audit and diagnostics
- Generate schemas from inbound HTML forms (form2schema) or XSD documents (xsd2schema)
- Manage password change flows and CSRF tokens through dedicated command endpoints

## Use cases

### Form-data ingestion service

An EFormBin deployment ingests submissions from a variety of forms across an organisation. Operators use the bin and bin-attribute endpoints to model the data, the bin-instance endpoints to query stored records, and the activity timegraph endpoint to monitor traffic. The 177-endpoint surface mirrors the full admin UI, so operations work that previously required a browser session can run as automated jobs.

Example prompt: GET /bin to list all bins, then GET `/bininstance/{bin}` for the target bin to enumerate its stored records.

### Schema generation from existing assets

Teams adopting EFormBin often have legacy HTML forms or XSD documents and need matching Eleusoft schemas to onboard them. The form2schema and xsd2schema endpoints accept the source document and return a schema definition, which can be persisted back into EFormBin as a new bin. This shortens migration projects from days to minutes per form.

Example prompt: POST the existing XSD to /xsd2schema and persist the resulting Eleusoft schema by creating a new bin via POST /bin.

### User and role administration

An admin tool driven by the EFormBin API provisions users, assigns roles, and manages profiles and OAuth app-user records without UI clicks. The login-log and error-handler-log endpoints support investigations when users report access problems. Because the spec exposes 177 admin operations, an automation can perform bulk changes that would otherwise require manual session work.

Example prompt: Use the user, role, and profile endpoints to provision a new user and assign their role, then read /loginLog to confirm a successful first login.

### EFormBin admin agent through Jentic

An operations agent fields admin requests for an EFormBin deployment - adding bins, generating schemas, and pulling logs - and must do so against a 177-endpoint surface. Through Jentic, the agent searches by intent, receives the matching operation, and executes it. Jentic shields the agent from the full breadth of the spec.

Example prompt: Search Jentic for 'create a bin attribute in EFormBin', load the schema, execute the call, and verify with a follow-up listing.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/bin` | List bins and attributes |
| POST | `/bin` | Create a bin |
| DELETE | `/delete/*` | Delete a bin |
| GET | `/activity` | Time-graph of activity for a bin query |
| POST | `/xsd2schema` | Generate a schema from an XSD |
| GET | `/csrf.do` | Expose a CSRF token |
| POST | `/changePassword.do` | Change a user's password |

## Key resources

- **Bin** — Manage bins, the top-level containers in EFormBin
- **BinAttribute** — Manage attributes that define what a bin stores
- **BinInstance** — Query and manage concrete records stored inside a bin
- **User** — Provision users and manage their profiles
- **Role** — Manage role definitions and assignments
- **OAuthAppUser** — Manage OAuth-app-user records
- **ErrHandlerLog** — Read error-handler log entries
- **form2schema / xsd2schema** — Generate Eleusoft schemas from HTML forms or XSDs

## Why Jentic

- **Setup:** Wiring EFormBin by hand means tracking its session and CSRF handling and stitching the bin, schema, and log operations together across a wide surface yourself. Through Jentic you install once, import the Eleusoft EfBin.org API from the API Directory, store any session credential once, and your agent calls it.
- **Permission scoping:** These EFormBin operations identify targets through the request or a wildcard delete path rather than a stable resource id, so scope the agent by operation: limit it to the calls it needs, such as GET /bin and POST /xsd2schema. You choose the operations it may call, so DELETE /delete/* is not included unless you add it.
- **Credential handling:** Any EFormBin session credential or CSRF 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 'create a bin' or 'generate a schema from XSD', and Jentic returns the matching EFormBin operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Typeform API** — Typeform is a hosted form builder and response store with a much narrower, modern API surface.
- **JotForm API** — JotForm offers hosted form creation, submission storage, and reporting in a SaaS model.
- **Auth0 API** — Auth0 manages identity for systems that consume an EFormBin deployment as a downstream form store.

## FAQ

### What authentication does the Eleusoft EfBin.org API use?

The OpenAPI spec does not declare a security scheme, but the API documentation states that most calls require the user to be authorised. Authorisation is handled by the EFormBin server itself, typically via a session and CSRF token retrieved from /csrf.do. Jentic stores any provided credentials encrypted and injects them at execution time.

### Can I generate a schema from an existing form with this API?

Yes. POST /form2schema generates an Eleusoft schema from an HTML form, and POST /xsd2schema generates one from an XSD. Both endpoints accept the source document and return a schema definition you can persist back into EFormBin.

### How do I list and manage bins through the API?

GET /bin lists bins and their attributes, POST /bin creates a new bin, and DELETE /delete/* removes one. Bin attributes are managed through the dedicated BinAttribute endpoints, and the BinInstance endpoints expose concrete records stored inside each bin.

### What are the rate limits for the EfBin.org API?

Rate limits are not declared in the spec. As a self-hosted Eleusoft deployment, practical limits depend on the operator's server. Build retries with exponential backoff and avoid tight polling on the activity timegraph and log endpoints.

### How do I create a bin through Jentic?

Run pip install jentic, search Jentic for 'create a bin in EFormBin', load the POST /bin schema, and execute the call with the bin name and attributes. Jentic handles credential and CSRF-token injection so the agent does not need to manage either directly.

### Does the API expose audit and error logs?

Yes. The ErrHandlerLog endpoints return error-handler log entries and the LoginLog endpoints expose login history. Use these together with /activity to investigate access or processing problems.

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

Yes. Because you run Jentic One yourself, you decide which EFormBin operations your agent may call, so you can allow only what a task needs, such as GET /bin to list bins and POST /xsd2schema to generate a schema, while withholding everything else. Since these operations identify their target through the request rather than a stable resource id, scoping is done per operation, which means a destructive call like DELETE /delete/* is not available to the agent unless you explicitly add it. Any EFormBin session credential or CSRF token is held by your own instance and injected only when an allowed call runs.
