Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. By signing up you are subscribing to the APIs.io and API Evangelist
newsletters — you can unsubscribe from any issue. See our
Privacy Policy and Terms.
openapi: 3.2.0
info:
title: eVerbary Order Sandbox API
description: 'Place certified translation orders from your own software, follow them, and get
the finished translation back.
**Authentication.** Send your key as `Authorization: Bearer ` or
`X-API-Key: `. Keys are issued from your eVerbary account (or by
support@everbary.com). `GET /v1/me` tells you which account a key belongs to.
**Test mode (sandbox).** A key that starts with `ev_test_` works on every
endpoint below, but its orders are pretend: nothing is placed, charged, emailed
or sent to a translator, and the documents you upload are checked and then
discarded. Prices, languages and validation are the live ones, so what works in
test works in live. A test order moves on its own - `new`, then `in-progress`
after about a minute, then `completed` two minutes later with a sample
translation and certificate attached - and each move is delivered to your
webhook, signed exactly as in live. `POST /v1/sandbox/orders/{n}/advance`
skips the wait; a `reference` or `note` containing `sandbox:cancel` makes the
order end `cancelled`. Test orders are numbered from 900001 and kept 30 days.
Responses for test orders carry `"sandbox": true`.
**Webhooks.** `PUT /v1/webhook` registers one https URL per key and returns its
signing secret once. Every delivery is a POST with `X-Everbary-Event` (e.g.
`order.completed`) and `X-Everbary-Signature: t=,v1=`, an
HMAC-SHA256 over `"."`. Verify it, and reject timestamps older than
a few minutes. Failed deliveries are retried with a widening gap.
**Embedded checkout.** For case-management software that wants a "Translate
with eVerbary" button: `POST /v1/checkout/sessions` with the person, the case and
the documents (signed links or base64) returns a `url` on orders.everbary.com.
Send the person there: they choose languages and turnaround, see their
account''s price, and place the order, paying now or later. An account is opened
for them if they have none. The order''s webhook deliveries carry
`checkoutSession`, `caseId` and your `metadata` back. Works with test keys
(sandbox orders, no account opened). Try it: https://orders.everbary.com/checkout/demo
**Idempotency.** Send `Idempotency-Key` with `POST /v1/orders`: a retried
request returns the original order instead of placing a second one.
Questions: support@everbary.com.'
version: 1.1.0
tags:
- name: Sandbox
paths:
/v1/sandbox/orders/{order_number}/advance:
post:
summary: Sandbox Advance
description: 'Test keys only: move a test order on now instead of waiting.
The change is delivered to the key''s webhook within seconds, as if it
had happened by itself.'
operationId: sandbox_advance_v1_sandbox_orders__order_number__advance_post
parameters:
- name: order_number
in: path
required: true
schema:
type: integer
title: Order Number
- name: authorization
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Authorization
- name: x-api-key
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: X-Api-Key
requestBody:
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Body_sandbox_advance_v1_sandbox_orders__order_number__advance_post'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Sandbox
components:
schemas:
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
type: object
required:
- loc
- msg
- type
title: ValidationError
Body_sandbox_advance_v1_sandbox_orders__order_number__advance_post:
properties:
to:
type: string
title: To
description: in-progress, completed or cancelled; empty for the next step.
default: ''
type: object
title: Body_sandbox_advance_v1_sandbox_orders__order_number__advance_post
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError