Softserveincsoftserveinc.com

ScoredOct 30, 2026, 07:33 PM

Softserveinc's API program shows meaningful strength in structured data but has critical gaps in two areas that directly block partner and agent adoption: agent-readiness (no machine-readable context files, no security contact, no runnable collections) and developer onboarding (zero code samples across sampled documentation). Closing these gaps — starting with the runnable and discoverable surfaces agents rely on, then hardening the documentation with examples and security hygiene — will move the program from invisible to self-serve ready for both human partners and AI-driven integrations.

API DesignA clean, typed, well-governed API contract agents can reason about0 pass0 warn2 fail40F

Signal	Points	Findings	Rationale
Security & governance hygienevia wellknown	0/15	No security.txt found at /.well-known/security.txt or /security.txt, so there's no machine-readable security contact for agents or researchers. Investigated: wellknown 0%. Fix: Publish an RFC 9116 security.txt with a Contact line and a future Expires date.	No leaked secrets, no critical lint violations, no OWASP API Top-10 spec smells, and a published vulnerability-disclosure channel.
Example coveragevia docs	0/10	No code samples detected across 1 sampled docs pages, so a coding agent gets no ready-to-use examples. Investigated: docs 0%. Fix: Add copy-pasteable code samples to API reference and quickstart pages.	Examples carry shape semantics schemas under-specify — for humans and agents alike.
Machine-readable, versioned contract	—/25	No surface produced evidence for this capability in this run.	A current OpenAPI version with a declared versioning scheme lets agents reason about the contract.
Schema coverage & depth	—/25	No surface produced evidence for this capability in this run.	Typed, complete request/response schemas are what make agent function-calling possible.
Auth declared & discoverable	—/25	No surface produced evidence for this capability in this run.	Agents can only call an API when they can determine its auth posture — a declared scheme, or an explicit statement that none is required.

Developer ExperienceThe context both developers and agents need to integrate fast — onboarding, code samples, complete descriptions and worked examples1 pass1 warn1 fail66C

Signal	Points	Findings	Rationale
Self-service developer portalvia docs	29/29	Signup page found at https://www.softserveinc.com/en-us/free, but no free tier or sandbox is documented in docs/pricing, so an agent may hit a paywall. Investigated: docs 100%.	A first call without a human in the loop — self-serve credentials, a free tier, or an API that needs none.
Quickstart presentvia docs	12.5/25	Quickstart page is reachable at https://www.softserveinc.com/payments/quickstart (3 variants scanned) but has no runnable code sample in its HTML or .md variant, so there's nothing to copy and run. Investigated: docs 50%. Fix: Add a copy-pasteable curl or SDK call, with the expected response, to the quickstart page (or its .md variant).	A quickstart is the fastest path from landing page to first successful call.
Code samples in docsvia docs	0/18	No code samples detected across 1 sampled docs pages, so a coding agent gets no ready-to-use examples. Investigated: docs 0%. Fix: Add copy-pasteable code samples to API reference and quickstart pages.	Multi-language samples shorten time-to-first-call.
Description completeness	—/15	No surface produced evidence for this capability in this run.	Complete descriptions are the context humans and agents need to use endpoints.
Changelog published	—/13	No surface produced evidence for this capability in this run.	A published changelog lets partners track changes without surprise.

Agent DiscoveryPartners and their agents can find your APIs — llms.txt, registries, crawlable and reachable docs2 pass0 warn1 fail66C

Signal	Points	Findings	Rationale
Registry & SDK presencevia cli	28/28	CLI documented with install instructions (download, download, download). Investigated: cli 100%, docs 0%, sdk 0%.	Listing in MCP registries and publishing SDKs puts the API where agents and their tooling look.
Crawlable / AEOvia wellknown	12/12	robots.txt lets all monitored AI crawlers reach the docs paths. Investigated: wellknown 100%.	Bots allowed plus a fresh sitemap make docs findable by agent crawlers.
llms.txt present, valid & comprehensivevia docs	0/30	No llms-full.txt was found at any candidate origin, so agents can't grab your full docs in one fetch. Investigated: docs 0%. Fix: Publish a concatenated, agent-readable copy of your documentation at /llms-full.txt on your docs site.	A valid, comprehensive llms.txt is the machine-readable entry point for agents.
Docs reachable, not hard auth-gated	—/30	No surface produced evidence for this capability in this run.	Agents can only index and fetch docs they can reach — past auth gates and over correct HTTP semantics.

Agent UnderstandingAgents can correctly interpret your APIs — machine-readable errors, consistent descriptions, structured data, parseable docs0 pass1 warn1 fail46F

Signal	Points	Findings	Rationale
Docs structured datavia docs	4/8	Only OpenGraph/meta tags across 1 assessed pages — no JSON-LD for AI answer engines to cite. Investigated: docs 50%. Fix: Emit JSON-LD with Article/TechArticle @type and dateModified in the rendered docs head.	Structured data (JSON-LD/schema.org) on docs pages gives agents an unambiguous parse target and is what answer engines cite. Detected on the JS-rendered head (Firecrawl) for a bounded page budget, so JS-injected JSON-LD is now caught; pages we can't render are excluded rather than failed.
Agent instructions file (AGENTS.md)via wellknown	0/10	No AGENTS.md at the site root or /.well-known/, so coding agents have no ready-made setup and usage instructions. Investigated: wellknown 0%. Fix: Publish an AGENTS.md with setup, auth, and usage instructions a coding agent can follow.	An AGENTS.md gives coding agents explicit setup, auth, and usage instructions to interpret and operate the API — beyond llms.txt's link index.
Machine-readable errors (RFC 9457)	—/28	No surface produced evidence for this capability in this run.	RFC 9457 problem details and a documented error-code inventory let agents parse failures without burning tokens.
Operation purpose clarity	—/25	No surface produced evidence for this capability in this run.	Agents select the right endpoint from its summary + operationId; clear, named operations make tool-selection reliable — the strongest driver of correct tool choice.
Agent-navigable, token-efficient docs	—/22	No surface produced evidence for this capability in this run.	Server-rendered, clean, small-footprint docs are what an agent can cheaply fetch and parse correctly.
Description consistency across surfaces	—/7	Only 1 surface description(s) with ≥6 tokens available; need at least 2 to compare.	Every surface tells the same story about what the product is.

Agent UsabilityAgents have the context to use your APIs reliably, not just find them0 pass0 warn1 fail40F

Signal	Points	Findings	Rationale
Runnable collection with test scriptsvia platform	0/9	No public Postman workspace found for the org, so there's no runnable collection an agent can execute against. Investigated: platform 0%. Fix: Publish at least one public Postman workspace and link it from your developer portal so agents can use Run-in-Postman.	A public, maintained collection with assertions is runnable truth agents validate against.
Idempotency documented	—/27	No surface produced evidence for this capability in this run.	Documented idempotency lets agents retry safely.
Rate-limit signaling	—/22	No surface produced evidence for this capability in this run.	Machine-readable rate-limit headers let agents throttle adaptively.
Pagination documented & consistent	—/22	No surface produced evidence for this capability in this run.	Consistent, documented pagination lets agents traverse collections.
Sandbox separation	—/20	No surface produced evidence for this capability in this run.	An isolated environment lets agents exercise destructive operations safely.

Want to improve your results?