Overview
API v1 answers at your school address, https://<your school>/api/v1, on the Cademí subdomain or a custom domain. Release 1.0.0 is the first documented contract of an API that has served integrations since Cademí v4; it receives fixes only. New integrations should use API v3; see Migrating to v3.
Field names are in Portuguese (nome, celular, criado_em) and IDs are numbers. Students are identified by ID, email or document (CPF) in the same path parameter.
Lists are paginated by cursor, 150 items per page. Follow data.paginator.next_page_url until it is null; do not build the cursor yourself.
See Authentication, Errors and the reference.
Create or extend a delivery POST
Makes sure a delivery of the gateway listens to the given product IDs. When a delivery already has one of the IDs, the missing ones are added to it (its name and type do not change). When none has them, a new delivery is created. An ID that belongs to a different delivery is refused. The delivery is nested twice: `data.data`.
Authentication
Next Page