Skip to content
CheckcraftDownload
Practical workflow

How to accept an API from a contractor: checks against the spec and a test report

Checkcraft is a desktop app for checking APIs and logs without code, with a free edition. Download, no sign-up →

A demo shows the happy path. What breaks is what a demo does not show: totals, repeats, errors inside the service behind a 200. Check it before you sign.

Checkcraft ·

Get help with your first test →

Why a demo is not acceptance

In a demo the contractor walks through a scenario that is known to work. The defects hide elsewhere: a total that is off by a cent, a repeated request that creates a duplicate, a 200 response while an internal step fails and logs an error. Under Russian civil law (art. 720 of the Civil Code), unless the contract says otherwise, a client who accepts work without checking loses the right to cite defects an ordinary inspection would have found. So check before signing and record what you find in the acceptance document.

From the spec to verifiable criteria

Take every requirement and write it so the result is yes or no. For each check, note where the expected value comes from: the spec, a formula, a reference list. A value copied from the current API response will not do: then the check confirms what was built, not what was ordered. Add a separate line for what must happen inside: a log record, an event, no errors.

Requirement:
  "When an order is paid, its status becomes PAID, the total equals the sum
   of the items, and the payment event is logged without errors."

Acceptance checks:
  1. status code is 200
  2. status equals PAID
  3. total equals the sum of items[].amount
  4. the service log has no ERROR records for the request traceId
  5. repeating the same request does not create a second payment

What usually goes unchecked

A spec usually describes the happy path. For acceptance, add: invalid data gives a clear 400, not a 500; no rights gives 401 or 403; repeating the same request creates no second payment or order; an empty list and a large volume; required and extra fields in the response. And the logs: a 200 says nothing about background steps, while an ERROR record for the same request does.

Who writes the checks

The acceptance checks are prepared by the client side from the spec: an analyst or whoever is responsible for the result. If the contractor writes the test method for a finished product, it describes what was built rather than what was ordered. If the contractor wrote the code with AI, tests from the same context repeat the same mistakes. The contractor’s tests are useful, but acceptance needs an independent check.

The report

Record the environment and build version, the date, the list of checks with each result, and the differences found: the request, the response received, the expectation and the spec item. Attach the report to the acceptance document or list the defects in it, so you can cite them and require fixes. After the fix, run the same set again and compare.

Test report
  Environment:  test, contractor build 1.4.2
  Date:         2026-11-14
  Checks:       18, passed 16, failed 2
  Differences:
    req. 3.2  total = 301, expected 300 (items 100 + 200)
    req. 3.5  payments log for traceId 4bf92f… has ERROR: queue not available

How to do it in Checkcraft

Import the contractor’s requests from cURL, Postman or OpenAPI and set rules from the spec without code: field values, totals by formula, required fields. A log step finds Kibana records by the request traceId and checks them, for example "no ERROR records". A run produces an HTML, TXT or JUnit report, which serves as the test report. The check set is saved as a file and rerun after every fix. Log checks and reports are in the free version; database checks are in Pro.

Next step

Repeat this on your own API

Checkcraft is a desktop app that saves API response checks without code and shows what did not match. Start with a sample, then use your own sanitized data. Free runs on Windows and Linux with no time limit.

Download FreeDownload and first run

No sign-up or email needed, the archive is ready in a couple of minutes. See the edition limits.

References

Russian Civil Code, art. 720: acceptance of work (in Russian)

Start with the linked example and compare its result with your own test requirement.

Ask a person

Get help with your first test

Tell us what you want to test or where you got stuck. We can help you start Checkcraft, choose an example and understand your first run. You can ask before downloading.

The Telegram group is public: do not post passwords, tokens or confidential work data. A description of your task is enough to start.

You can also email us support@checkcraft.ru

No account required. We will reply by email. This is a support request, not a newsletter subscription.