canonical: https://jentic.com/apis/sofy.fr/sofy-fr

# Sofy Fr Sofy API

The API intended for use by sofy customers <br><strong>Production environment</strong>. The API exposes 17 endpoints secured with apiKey authentication.

## For AI agents

Programmatically health, createbroadcast. Covers 17 operations with apiKey authentication.

## Scope

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

## Capabilities

- health
- createBroadcast
- create
- retrieveAll
- retrieve
- delete

## Use cases

### E-Commerce Operations

Use the Sofy API to perform e commerce operations programmatically. The API provides 17 endpoints covering core functionality including health, createbroadcast, create.

Example prompt: Call GET /health to health

### Automated contacts Management

Automate contacts operations by combining multiple Sofy API endpoints. Agents can createbroadcast and then create in a single workflow.

Example prompt: Call POST `/sms/broadcasts` to createbroadcast, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Sofy 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 'health', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/health` | health |
| POST | `/sms/broadcasts` | createBroadcast |
| POST | `/sms` | create |
| GET | `/groups/{groupId}/contacts` | retrieveAll |
| GET | `/groups/{groupId}/contacts/{id}` | retrieve |
| DELETE | `/groups/{groupId}/contacts/{id}` | delete |

## Key resources

- **contacts** — Operations related to contacts
- **customColumns** — Operations related to customColumns
- **groups** — Operations related to groups
- **sms** — Operations related to sms
- **wallets** — Operations related to wallets

## Why Jentic

- **Setup:** Wiring the Sofy API by hand means sending both the X-API-KEY-ID and X-API-KEY-SECRET headers on every request, pointing at the api.sofy.fr/v1 host, and threading the group id through each contacts call yourself. Through Jentic you install once, import the Sofy API from the API Directory, store the key pair once, and your agent calls it.
- **Permission scoping:** The Sofy API puts the group id in the URL path (`/groups/{groupId}/contacts/...`), so a rule can pin your agent to one group: it can read that group's contacts and nothing else. You choose the operations it may call, so destructive ones like deleting a contact are not included unless you add them.
- **Credential handling:** Your Sofy API key pair 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 'send an SMS broadcast' or 'list contacts in a group', and Jentic returns the matching Sofy 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 Sofy API use?

The Sofy API uses an API key passed in the `X-API-KEY-ID` 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 health with the Sofy API?

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

### What are the rate limits for the Sofy 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 health through Jentic?

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

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

The Sofy API exposes 17 endpoints covering contacts, customcolumns, groups operations.

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

Yes. Because you run Jentic One yourself, your own rules decide which Sofy API operations and credentials the agent may use. Since the Sofy API carries the group id in the URL path (`/groups/{groupId}/contacts/...`), you can pin the agent to a single group so it only reads that group's contacts and nothing else. You also choose exactly which operations it may call, so a destructive one like deleting a contact is excluded unless you explicitly add it, while allowing it to send SMS broadcasts or list group contacts.