API
Integrate Rikochey on a website
Everything a developer needs: the script to paste, how a submission travels, and the token API. No account required to read this page.
Getting started
The script to add, how it loads your forms, what it publishes, how to point it at your forms, and in which language.
- Embed the script One tag to paste on every page of the website, and what it does.
- How forms are loaded How the script finds the forms of a page, loads them in one request, and picks up forms added later.
- What the script publishes The global variables set on window, and exactly what they contain.
- Automatic rendering or attached mode The attribute that designates a form, and the two ways the script handles it.
- Languages How the script picks the language of a form, how to force it, and what the server does with it.
Client libraries
Ready-made clients for the API, by language, and the integrations built on them.
Submission
The journey of a request: signature, captcha, submission, errors.
- Load the forms of a page The endpoint the script calls to get the forms of a page, already translated.
- Submit a form The endpoint that records a request, its headers and its responses.
- The submission signature The short-lived token that authorizes a submission.
- The captcha The provider chain, the fallback, and ALTCHA's two endpoints.
- Validation errors The format of a 422, and the language of the messages returned to the visitor.
Visit tracking
The tracking call sent on every page view, and what it records.
Token API
Query your websites from a server, with a Bearer token.
- Obtain and manage a key Where an API key comes from, who can hold one, its scope, and how it is revoked.
- List websites The directory of the organization's websites, in full or by department.
- Get a website A website's full record, for a token bearer from its organization.
- List a website's forms The script address and the active forms of a website, to place them in a CMS.
Reference
Conventions, error codes and rate limits.