Overview

API v2 answers at your school address, https://<your school>/api/v2, on the Cademí subdomain or a custom domain. Release 2.0.0 is the first documented contract of the API that sales partners use to connect gateways to Cademí; it receives fixes only. New integrations should use API v3; see Migrating to v3.

v2 covers three things: the transactions Cademí received from a gateway, the access entries of a student, and the deliveries that turn a gateway product into access. Field names are in English and IDs are numbers.

A student is identified by id:<ID>, email:<email> or doc:<document> in the identifier path parameter. A plain value also works.

See Authentication, Errors and the reference.