Sofy API

Name: Sofy API API
Brand: Sofy API
Availability: InStock

✓ Official Vendor SpecE CommerceStorefrontapiKey17 EndpointsREST

For Agents

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

Use for: I need to health, I want to createbroadcast, Search for create, Find all retrieveall

Connect the Sofy API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Sofy API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Install Jentic One Beta (Self-Hosted)

Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Sofy API API.

health

createBroadcast

create

retrieveAll

retrieve

GET STARTED

Start building with Sofy API API

Explore with Jentic

View OpenAPI Document

Use Cases

Patterns agents use Sofy API API for, with concrete tasks.

★ 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.

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.

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.

Search Jentic for 'health', load the operation schema, and execute with Jentic-managed credentials

Key Endpoints

17 endpoints — the api intended for use by sofy customers <br><strong>production environment</strong>.

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

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}

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Sofy API apiKey credentials are stored encrypted in the Jentic vault (MAXsystem). Agents receive scoped access tokens — raw secrets never enter the agent context.

Intent-based discovery

Agents search by intent (e.g., 'health') and Jentic returns the matching Sofy API operation with its input schema, so the agent can call the right endpoint without browsing docs.

Time to first call

Direct Sofy API integration: 1-3 days for auth handling, response parsing, and error cases. Through Jentic: under 1 hour — search, load schema, execute.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

Shopify

Alternative e commerce API

Choose Shopify when you need a different approach to e commerce operations

Alternative

Stripe

Alternative e commerce API

Choose Stripe when you need a different approach to e commerce operations

FAQs

Specific to using Sofy API API through Jentic.

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 the MAXsystem vault 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 at https://app.jentic.com/sign-up, 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.