The WCEA API provides an access point for organizations to manage their accounts, users, e-learning and related metadata, all by making remote requests from their own portals or CRM suites. It provides a backend interface to push and pull data in and out of the Verified system seamlessly.
The WCEA API is designed around REST, and is implemented to have resource-oriented and predictive URL endpoints.
It uses HTTP response codes to indicate the status of any given request and spews out valid HTTP Error codes when a request encounters any errors. HTTP Verbs are the order of the day and are used intuitively depending on the operation.
It also supports CORS (Cross-Origin Resource Sharing) to allow communication with the API via a client-side web application. However, you should be wary of exposing your API Secret in any form on any client-facing web applications.
Sandbox Mode
The WCEA API has a sandbox mode. Its designed to help you build your application using the API without affecting any live data.
It behaves exactly as the live API, only difference being it works on example data and portal links always go to the sandbox portal.
Single Sign-on (SSO) Notes
If you are implementing Single Sign-on, once Single Sign-on is live on your website, please ask the administrator of your Education Portal to go to Manage Portals and select the Protected Link option.
This will ensure that the portal is only accessible via the Single Sign-on link, access will be denied for any direct visits to the portal.
Obtaining your API key
If you haven't already been issued a key please send an email to support@wcea.education to request one.
Live API Endpoint
https://wceaapi.org/Sandbox API Endpoint
https://sandbox.wceaapi.org/HTTP Verbs Usage
- GET
- To Fetch a resource from the API
- PUT
- To Modify the contents of an existing resource
- POST
- To Add a new resource
- DELETE
- To Delete a resource
- OPTIONS
- To pre-flight authenticated CORS requests
- HEAD
- To obtain headers only, no data is returned
Installing the PHP SDK
The PHP SDK can be found at https://github.com/wcealliance/php-sdk.
There is a detailed README file at the repo explaining installation instructions by using Composer or a plain vanilla installation.