Training APIs
Sample REST APIs
Simple, no-setup APIs for practising REST integration in OutSystems. No registration needed.
| # | API Name | Method | Auth | View Signature |
|---|---|---|---|---|
| 01 |
Hello World
hello · Optional ?name= param
|
GET | No Auth | View → |
| 02 |
Get Users
users · Optional ?id= param
|
GET | No Auth | View → |
| 03 |
Currency Rate
currency · from / to / amount params
|
GET | No Auth | View → |
| 04 |
Admin Profile
me · Returns profile on valid credentials
|
GET | Basic Auth | View → |
| 05 |
Country List
countries · Optional ?region= filter
|
GET | No Auth | View → |
| 06 |
Product Catalogue
products · Paginated · page / limit / category
|
GET | No Auth | View → |
| 07 |
Survey Bulk Data
survey_api · 300–600 random records per call
|
POST | Header Auth | View → |
| 08 |
Chunk and Perform Embedding
chunk-and-perform-embedding · PDF → Azure AI Search JSON · optional Azure OpenAI embedding
|
POST | Header Auth | View → |
| 09 |
Delete Indexed Document
delete-indexed-document · Remove all Azure AI Search chunks by document_id
|
POST | Header Auth | View → |
Arithmetic API Series
Addition APIs — One Operation, Eight Styles
All 8 endpoints perform integer addition. Each one demonstrates a different way to call a REST API — input style, auth type, and response format. Ideal for OutSystems REST integration training.
| # | API Name | Method | Auth | View Signature |
|---|---|---|---|---|
| 01 |
Add — URL Parameters
add-url · ?input1=&input2= · JSON response
|
GET | No Auth | View → |
| 02 |
Add — JSON Body
add-body · POST {input1, input2} · JSON response
|
POST | No Auth | View → |
| 03 |
Add — Basic Auth
add-basic · URL params · username: admin / password: 1234
|
GET | Basic Auth | View → |
| 04 |
Add — Custom Auth
add-custom · Headers: api_key + api_secret
|
GET | Header Auth | View → |
| 05 |
Add — API Key
add-apikey · Single header: api_key
|
GET | Header Auth | View → |
| 06 |
Get JWT Token
add-token · POST api_key + api_secret → returns JWT
|
POST | Header Auth | View → |
| 07 |
Add — Bearer Token
add-bearer · Authorization: Bearer <JWT>
|
GET | Bearer Token | View → |
| 08 |
Add — Integer Response
add-int · Returns plain integer, not JSON
|
GET | No Auth | View → |
Credentials used across this series
Basic Auth:
admin / 1234 ·
API Key: api_key: lc-api-key-2024 ·
Custom: api_key + api_secret: lc@Secret#2024 ·
Bearer: get token from row 06 first
Logistics APIs
Live Logistics Integration Lab
Two providers (ZedEx & Universal) with header-based auth. Register as a partner to get your credentials and practise end-to-end OutSystems integration.
| # | API Name | Method | Auth | View Signature |
|---|---|---|---|---|
| 01 |
Post Consignment
logistic/api/{provider}/post-consignment.php · ZedEx & Universal
|
POST | Header Auth | View → |
| 02 |
Fetch Status
logistic/api/{provider}/fetch-status.php · ZedEx & Universal
|
GET | Header Auth | View → |
Register to get your API credentials
Choose ZedEx or Universal, register as a partner, and instantly receive your PartnerId, APIKey, and APISecret. Free, no approval needed.