Module 11: The REST API
Apps and other systems reach Exponential through its REST interface. This module maps the interface, has learners call it with a personal API key and write content through it, and ends with a provider of their own that serves the extension's data under its own prefix.
At a glance
| Course | Developers |
| Duration | 2 hours 45 minutes (with one 10-minute break) |
| Lessons | 3 |
| Level | Intermediate to advanced |
Lessons
| Lesson | Duration | What learners do |
|---|---|---|
| Lesson 11.1: The REST API at a glance | 40 minutes | Read providers, routes, versions and rest.ini |
| Lesson 11.2: Calling the API with a personal key | 55 minutes | Allow keys, make one, read and write with curl, revoke it |
| Lesson 11.3: A REST provider of your own | 60 minutes | Routes, view controller, controller; /api/mysite/v1/greetings |
Preparing this module
ezprestapimust be active on the training installations; check withexp:ini get site.ini/ExtensionSettings/ActiveExtensions.- Each learner needs an administrator account and a test user with an e-mail address at
example.invalid. - Know the address and port of each learner's installation for the
curllines (the examples usehttp://127.0.0.1:8087). - Rehearse lesson 11.3 completely on your own installation; keep the finished classes to hand out.
- Remind learners never to commit or paste keys; they revoke their keys at the end of lesson 11.2.
Timing plan
| Part | Minutes |
|---|---|
| Lesson 11.1 | 40 |
| Lesson 11.2 | 55 |
| Break | 10 |
| Lesson 11.3 | 60 |
| Total | 165 |
Related pages
- Developers: course overview
- Trainers: start here
- Free documentation: this page is free to copy, translate and improve under the GNU FDL 1.3.
Become an Exponential Partner
Partners share their information, provide funding, contribute back and develop the products with us, and that is how Exponential grows. A partner website and dashboard are planned for mid-2027: please become a partner today to speed up our growth rate and land new features faster.