cAPI - Core

Version 1.3.3 Stable

Released on: Tuesday, 08 August 2017 20:00

 

Maturity
Stable
Released on
Tuesday, 08 August 2017 20:00

What is cAPI?

Code named "Constant API", cAPI is the fantastic result of an effort to mesh the Slim micro-framework with the Joomla Framework / CMS. Once that goal was accomplished, it soon became obvious that just built a Joomla RESTful API was only the beginning! By leveraging Joomla's advanced "pluggable" architecture and robust ACL, cAPI can transform your website into a true middleware service for anything ranging from SQL servers, MongoDB servers and even Microsoft's Active Directory (think of the SSO possibilities!).

How does it work?

cAPI injects the Slim micro-framework into the Joomla application instance, allowing for service route plugins to be built at any level of the event stack. But that's only the beginning!

A Services Control Panel manages the creation of access tokens, Slim framework parameters and API rate limitation rules. This allows an administrator to create tokens mapped to specific Joomla users who in turn are assigned unique group permissions using Joomla ACL.

The service routes are built into Joomla plugins which can be enabled / disabled or assigned access permissions individually. This opens the door for development of feature expansions to the core cAPI services to expose 3rd party Joomla extensions, database querying or even remote LDAP as RESTful JSON APIs.

cAPI v1.3.3 includes a bug fix for the Download ID component parameter and how it populates extra_query field in the update_sites table. It's likely that the previous couple releases may not automatically update via the Joomla Updater (even with your Download ID configured). If that is the case, you should download and install cAPI Core v1.3.3, manually.

This release includes the following:

  • Remove extraneous tag_link_class parameter
  • Increment cAPI version to 1.3.3
  • Resolve bug with successful updating of dlid in update_sites table, extra_query field when editing the Download ID parameter in com_services component options.

Previous release:

  • Remove updateserver for services/slimjsonapiview plugin.Remove updateserver for services/slimjsonapiview plugin.
  • Remove updateserver for services/slimjsonapimiddleware plugin
  • Remove updateserver for services/slim
  • Remove updateserver for services/rest plugin.
  • Remove updateserver for services/joomla
  • Remove updateserver for lib_services.
  • Remove updateserver for com_services.
  • Build component options fields and logic to control view-access to Swagger UI routes for each services plugin.
  • Update Swagger definition description for cAPI.
  • Bug fixes to authentication for getUserDetailByTypeValue.
  • Allow Super Users (or where user's session matches requested user detail) to access getUserDetailByTypeValue
  • Return responses for getUserDetailByTypeValue as object instead of as sub-elements of array[0].
  • Require Super User permissions for getUserDetailByTypeValue.
  • Update Joomla minimum version to 3.6.
  • Update cAPI Core Package manifest file to include new include libraries and provide link to learn.getcapi.org.
  • Add additional services folders to lib_services.xml manifest.
  • Fix 500 error getCategoryListByIdCategories when searching category id which does not exist.
  • Update zircote/swagger-php 2.0.10
  • Update doctrine/annotations library
  • Add symfony/finder libraries
  • Fix typo in guzzlehttp vendor library folder name.
  • Updated lib_services.xml manifest to include new ReactPHP libraries.
  • Update Composer library files to include ReactPHP libraries.
  • Add libraries and associated dependencies for ReactPHP
  • Update zircote/swagger-php to v2.0.10
  • Upgrade Slim Framework to v2.6.3
  • Commit remaining unversioned files added to /libararies/services/
  • Include web.config in /libraries/services/
  • Commit updated symfony vendor library in /libraries/services/symfony to match J37.x
  • Included updated psr vendor library in /libraries/services/psr
  • Include updated Joomla vendor library in /libraries/services/joomla to match compatibility with Joomla 3.7.x
  • Increment Joomla ID to j37

Updated documentation can be found here:
http://learn.getcapi.org

API Doc and Sandbox

https://getcapi.io

View files

Version 1.3.2 Stable

Released on: Friday, 21 July 2017 20:00

 

Maturity
Stable
Released on
Friday, 21 July 2017 20:00

What is cAPI?

Code named "Constant API", cAPI is the fantastic result of an effort to mesh the Slim micro-framework with the Joomla Framework / CMS. Once that goal was accomplished, it soon became obvious that just built a Joomla RESTful API was only the beginning! By leveraging Joomla's advanced "pluggable" architecture and robust ACL, cAPI can transform your website into a true middleware service for anything ranging from SQL servers, MongoDB servers and even Microsoft's Active Directory (think of the SSO possibilities!).

How does it work?

cAPI injects the Slim micro-framework into the Joomla application instance, allowing for service route plugins to be built at any level of the event stack. But that's only the beginning!

A Services Control Panel manages the creation of access tokens, Slim framework parameters and API rate limitation rules. This allows an administrator to create tokens mapped to specific Joomla users who in turn are assigned unique group permissions using Joomla ACL.

The service routes are built into Joomla plugins which can be enabled / disabled or assigned access permissions individually. This opens the door for development of feature expansions to the core cAPI services to expose 3rd party Joomla extensions, database querying or even remote LDAP as RESTful JSON APIs.

cAPI v1.3.2 is one of the biggest releases to date, ecompassing not only bug fixes and feature improvements, but also including every component from the fantastic ReactPHP library. This lays the foundation for new functionality including asynchronous event handling, non-blocking I/O operations, high-speed messaging queuing and much more!

This release includes the following:

  • Remove updateserver for services/slimjsonapiview plugin.Remove updateserver for services/slimjsonapiview plugin.
  • Remove updateserver for services/slimjsonapimiddleware plugin
  • Remove updateserver for services/slim
  • Remove updateserver for services/rest plugin.
  • Remove updateserver for services/joomla
  • Remove updateserver for lib_services.
  • Remove updateserver for com_services.
  • Build component options fields and logic to control view-access to Swagger UI routes for each services plugin.
  • Update Swagger definition description for cAPI.
  • Bug fixes to authentication for getUserDetailByTypeValue.
  • Allow Super Users (or where user's session matches requested user detail) to access getUserDetailByTypeValue
  • Return responses for getUserDetailByTypeValue as object instead of as sub-elements of array[0].
  • Require Super User permissions for getUserDetailByTypeValue.
  • Update Joomla minimum version to 3.6.
  • Update cAPI Core Package manifest file to include new include libraries and provide link to learn.getcapi.org.
  • Add additional services folders to lib_services.xml manifest.
  • Fix 500 error getCategoryListByIdCategories when searching category id which does not exist.
  • Update zircote/swagger-php 2.0.10
  • Update doctrine/annotations library
  • Add symfony/finder libraries
  • Fix typo in guzzlehttp vendor library folder name.
  • Updated lib_services.xml manifest to include new ReactPHP libraries.
  • Update Composer library files to include ReactPHP libraries.
  • Add libraries and associated dependencies for ReactPHP
  • Update zircote/swagger-php to v2.0.10
  • Upgrade Slim Framework to v2.6.3
  • Commit remaining unversioned files added to /libararies/services/
  • Include web.config in /libraries/services/
  • Commit updated symfony vendor library in /libraries/services/symfony to match J37.x
  • Included updated psr vendor library in /libraries/services/psr
  • Include updated Joomla vendor library in /libraries/services/joomla to match compatibility with Joomla 3.7.x
  • Increment Joomla ID to j37

Previous release:

  • Swagger documentation fixes for Tag service routes.
  • BUG FIX - Resolved issue with REST API limitation for token access not working properly since version 1.2.8.

Updated documentation can be found here:
http://learn.getcapi.org

API Doc and Sandbox

https://getcapi.io

View files

Version 1.3.1 Stable

Released on: Thursday, 11 May 2017 20:00

 

Maturity
Stable
Released on
Thursday, 11 May 2017 20:00

What is cAPI?

Code named "Constant API", cAPI is the fantastic result of an effort to mesh the Slim micro-framework with the Joomla Framework / CMS. Once that goal was accomplished, it soon became obvious that just built a Joomla RESTful API was only the beginning! By leveraging Joomla's advanced "pluggable" architecture and robust ACL, cAPI can transform your website into a true middleware service for anything ranging from SQL servers, MongoDB servers and even Microsoft's Active Directory (think of the SSO possibilities!).

How does it work?

cAPI injects the Slim micro-framework into the Joomla application instance, allowing for service route plugins to be built at any level of the event stack. But that's only the beginning!

A Services Control Panel manages the creation of access tokens, Slim framework parameters and API rate limitation rules. This allows an administrator to create tokens mapped to specific Joomla users who in turn are assigned unique group permissions using Joomla ACL.

The service routes are built into Joomla plugins which can be enabled / disabled or assigned access permissions individually. This opens the door for development of feature expansions to the core cAPI services to expose 3rd party Joomla extensions, database querying or even remote LDAP as RESTful JSON APIs.

The release of cAPI v1.3.1 includes the following:

  • Swagger documentation fixes for Tag service routes.
  • BUG FIX - Resolved issue with REST API limitation for token access not working properly since version 1.2.8.

Previous release:

cAPI v1.3.0 is now fully compatible with Joomla 3.7!

  • Increment to v1.3.0. This is done to accommodate major changes to class autoloading from services plugins helpers. Also includes a minor response scheme change to GET /user route.
  • Refactor to register JLoader prefix "Services" to faciliate autoloading of helper classes in services plugins.
  • Correction to doc block summary for getTagFields.
  • Remove outside array dimension [0] from user getUser response.
  • Remove $application->getInstance();
  • Change to JUri()->isSSL() for SSL check in swaggerui administrative view.
  • Update class name instantiation to ServicesRestHelpersTokenmanage.
  • Cross domain access is now fully handled in code.
  • BUG: Update GET /token/:token to prevent auth failure when logging in with account matching existing session.
  • Updating to resolve compatibility issues with J3.7.
  • Update documentation for getTokenByToken.

Updated documentation can be found here:
http://learn.getcapi.org

API Doc and Sandbox

https://getcapi.io

View files

Version 1.3.0 Stable

Released on: Thursday, 27 April 2017 20:00

 

Maturity
Stable
Released on
Thursday, 27 April 2017 20:00

What is cAPI?

Code named "Constant API", cAPI is the fantastic result of an effort to mesh the Slim micro-framework with the Joomla Framework / CMS. Once that goal was accomplished, it soon became obvious that just built a Joomla RESTful API was only the beginning! By leveraging Joomla's advanced "pluggable" architecture and robust ACL, cAPI can transform your website into a true middleware service for anything ranging from SQL servers, MongoDB servers and even Microsoft's Active Directory (think of the SSO possibilities!).

How does it work?

cAPI injects the Slim micro-framework into the Joomla application instance, allowing for service route plugins to be built at any level of the event stack. But that's only the beginning!

A Services Control Panel manages the creation of access tokens, Slim framework parameters and API rate limitation rules. This allows an administrator to create tokens mapped to specific Joomla users who in turn are assigned unique group permissions using Joomla ACL.

The service routes are built into Joomla plugins which can be enabled / disabled or assigned access permissions individually. This opens the door for development of feature expansions to the core cAPI services to expose 3rd party Joomla extensions, database querying or even remote LDAP as RESTful JSON APIs.

The release of cAPI v1.3.0 includes changes to class autoloading from services plugins helpers. Also includes a minor response scheme change to GET /user route.. The next version of cAPI will handle tag assignment to com_content items.

cAPI v1.3.0 is now fully compatible with Joomla 3.7!

  • Increment to v1.3.0. This is done to accommodate major changes to class autoloading from services plugins helpers. Also includes a minor response scheme change to GET /user route.
  • Refactor to register JLoader prefix "Services" to faciliate autoloading of helper classes in services plugins.
  • Correction to doc block summary for getTagFields.
  • Remove outside array dimension [0] from user getUser response.
  • Remove $application->getInstance();
  • Change to JUri()->isSSL() for SSL check in swaggerui administrative view.
  • Update class name instantiation to ServicesRestHelpersTokenmanage.
  • Cross domain access is now fully handled in code.
  • BUG: Update GET /token/:token to prevent auth failure when logging in with account matching existing session.
  • Updating to resolve compatibility issues with J3.7.
  • Update documentation for getTokenByToken.

Updated documentation can be found here:
http://learn.getcapi.org

API Doc and Sandbox

https://getcapi.io

View files

Version 1.2.8 Stable

Released on: Thursday, 13 April 2017 20:00

 

Maturity
Stable
Released on
Thursday, 13 April 2017 20:00

What is cAPI?

Code named "Constant API", cAPI is the fantastic result of an effort to mesh the Slim micro-framework with the Joomla Framework / CMS. Once that goal was accomplished, it soon became obvious that just built a Joomla RESTful API was only the beginning! By leveraging Joomla's advanced "pluggable" architecture and robust ACL, cAPI can transform your website into a true middleware service for anything ranging from SQL servers, MongoDB servers and even Microsoft's Active Directory (think of the SSO possibilities!).

How does it work?

cAPI injects the Slim micro-framework into the Joomla application instance, allowing for service route plugins to be built at any level of the event stack. But that's only the beginning!

A Services Control Panel manages the creation of access tokens, Slim framework parameters and API rate limitation rules. This allows an administrator to create tokens mapped to specific Joomla users who in turn are assigned unique group permissions using Joomla ACL.

The service routes are built into Joomla plugins which can be enabled / disabled or assigned access permissions individually. This opens the door for development of feature expansions to the core cAPI services to expose 3rd party Joomla extensions, database querying or even remote LDAP as RESTful JSON APIs.

The release of cAPI v1.2.8 includes new Joomal Tag methods to allow create / read / update / delete and tag search. The next version of cAPI will handle tag assignment to com_content items.

A new menu item view has been added to com_services to allow site admins to create Swagger UI interfaces for any Swagger JSON definition URLs. 

Commit Message  
47818e5ed11 Remove unnecessary language item definition.
f25e6b2d67d Remove unnecessary array definition.
1d09ae78e87 Remove slim_php_framework view and related files and language parameters as they are no longer needed.
956a56313ae Symmetrically encrypt swaggerjson path parameter as "cryptoKey" key value store in user session.
a726cd3562a Create service route getSlimSwaggerRemoteByUrl.Update com_services to use this route for the view swaggeruimisc.
982c4c98801 Commit previously unversioned files.
2c50d5da210 Menu item parameter configuration for swaggeruimisc view for com_services
c51921d1eaa Create swaggeruimisc view for com_services to allow for front-end presentation of any pre-configured Swagger JSON definition file.
416cea8ca97 Resolve issues with proper handling of CORS preflight requests.
745e2515fb8 Fix bug with proper setting of Access-Control-Allow-Origin with respect to CORS.
9a91f513903 Update token handling for parameter and header value to ensure acceptance.
adc6a78fb64 Created PUT /tag and DELETE /tag methods.Working on Swagger docs.
75233fa07ad Use jModel for postTag.Improve getTagNameById
82edd622fc9 Complete initial work on postTag.TODO: Finish metadata handling and parameters. Finish swagger doc block.
a5cfd0d7c7f getTagFields, postTag
83c97cd9f3e getTagTypes, getTagSearch, getTagNameById
9d9bc9544a2 Build new Tag methods.
a3e35260d55 span title="Include "Authorization" in Access-Control-Allow-Headers as per request Include "Authorization" in Access-Control-Allow-Headers as per request https://www.annatech.com/forums/capi-wish-list/25-adding-authorization-in-htaccess.html#84
ab554d3b9a9 Update version and year.

Updated documentation can be found here:
http://learn.getcapi.org

API Doc and Sandbox

https://getcapi.io

View files

Version 1.2.7 Stable

Released on: Wednesday, 23 November 2016 19:00

 

Maturity
Stable
Released on
Wednesday, 23 November 2016 19:00

What is cAPI?

Code named "Constant API", cAPI is the fantastic result of an effort to mesh the Slim micro-framework with the Joomla Framework / CMS. Once that goal was accomplished, it soon became obvious that just built a Joomla RESTful API was only the beginning! By leveraging Joomla's advanced "pluggable" architecture and robust ACL, cAPI can transform your website into a true middleware service for anything ranging from SQL servers, MongoDB servers and even Microsoft's Active Directory (think of the SSO possibilities!).

How does it work?

cAPI injects the Slim micro-framework into the Joomla application instance, allowing for service route plugins to be built at any level of the event stack. But that's only the beginning!

A Services Control Panel manages the creation of access tokens, Slim framework parameters and API rate limitation rules. This allows an administrator to create tokens mapped to specific Joomla users who in turn are assigned unique group permissions using Joomla ACL.

The service routes are built into Joomla plugins which can be enabled / disabled or assigned access permissions individually. This opens the door for development of feature expansions to the core cAPI services to expose 3rd party Joomla extensions, database querying or even remote LDAP as RESTful JSON APIs.

cAPI Core v1.2.7 is a slightly larger update than 1.2.6 as it not only fixes some bugs in field handling, but also introduces a couple updatable fields from content methods along with many fixes to the Swagger UI in-line code documentation.

62673af776d Updates related to token security logic.Required for upcoming cAPI K2 REST services plugin.
dfdc42750c1 Fix method annotation errors in tokenManage.php.
909403b3dda Fix incorrect license URL format in build.xml.
f5cede39e21 Add missing "id" path parameter to annotation for putUserProfileById.
498d7a042b9 Fix various annotations errors for Joomla user methods.
ee2e36df949 Fix annotation error for GET /user/login/{username}/{password}.
1012adde221 Resolve some Swagger validation errors due to how host and basepath are defined along with an errant Swagger annotation in ars.php.
888134f99f8 Add "/" to basepath definition.
8541aa4a664 Updated GET /slim/swagger method to generate Swagger Doc with HTTP transport scheme matching the root URI, whether it is HTTPS or HTTP (ssl or no-ssl).
e0869609927 Update method annotation for putContentUpdateById and postContentCreate.
af6d0dcdf65 Allow updates to modified_field in putContentUpdateByID.
5b3a4451655 Update putContentUpdateById to update alias automatically if title is changed by alias is not specified.
5f1dd3fb403 Update version to 1.2.7
1b389576fc1 Fix token authentication bug which broke sessions persistence with server-side curl requests.

Updated documentation can be found here:
http://learn.getcapi.org

API Doc and Sandbox

https://getcapi.io

View files

Version 1.2.6 Stable

Released on: Tuesday, 20 September 2016 20:00

 

Maturity
Stable
Released on
Tuesday, 20 September 2016 20:00

What is cAPI?

Code named "Constant API", cAPI is the fantastic result of an effort to mesh the Slim micro-framework with the Joomla Framework / CMS. Once that goal was accomplished, it soon became obvious that just built a Joomla RESTful API was only the beginning! By leveraging Joomla's advanced "pluggable" architecture and robust ACL, cAPI can transform your website into a true middleware service for anything ranging from SQL servers, MongoDB servers and even Microsoft's Active Directory (think of the SSO possibilities!).

How does it work?

cAPI injects the Slim micro-framework into the Joomla application instance, allowing for service route plugins to be built at any level of the event stack. But that's only the beginning!

A Services Control Panel manages the creation of access tokens, Slim framework parameters and API rate limitation rules. This allows an administrator to create tokens mapped to specific Joomla users who in turn are assigned unique group permissions using Joomla ACL.

The service routes are built into Joomla plugins which can be enabled / disabled or assigned access permissions individually. This opens the door for development of feature expansions to the core cAPI services to expose 3rd party Joomla extensions, database querying or even remote LDAP as RESTful JSON APIs.

cAPI Core v1.2.6 is a minor upgrade with code fixes to Swagger docblocks a minor permission change to start on the path of managing access with standard Joomla authorization lookups.

Note:

The component title has changed,

FROM:

"Services Control Panel"

TO:

"cAPI Core REST API"

Make sure to look for the new component name when managing your tokens or accessing documentation.

Updated documentation can be found here:
http://learn.getcapi.org

API Doc and Sandbox

https://getcapi.io

View files

Version 1.2.5 Stable

Released on: Wednesday, 07 September 2016 20:00

 

Maturity
Stable
Released on
Wednesday, 07 September 2016 20:00

What is cAPI?

Code named "Constant API", cAPI is the fantastic result of an effort to mesh the Slim micro-framework with the Joomla Framework / CMS. Once that goal was accomplished, it soon became obvious that just built a Joomla RESTful API was only the beginning! By leveraging Joomla's advanced "pluggable" architecture and robust ACL, cAPI can transform your website into a true middleware service for anything ranging from SQL servers, MongoDB servers and even Microsoft's Active Directory (think of the SSO possibilities!).

How does it work?

cAPI injects the Slim micro-framework into the Joomla application instance, allowing for service route plugins to be built at any level of the event stack. But that's only the beginning!

A Services Control Panel manages the creation of access tokens, Slim framework parameters and API rate limitation rules. This allows an administrator to create tokens mapped to specific Joomla users who in turn are assigned unique group permissions using Joomla ACL.

The service routes are built into Joomla plugins which can be enabled / disabled or assigned access permissions individually. This opens the door for development of feature expansions to the core cAPI services to expose 3rd party Joomla extensions, database querying or even remote LDAP as RESTful JSON APIs.

cAPI Core v1.2.5 introduces new methods for remotely managing access tokens and Swagger.json documentation built directly into the code!

Updated documentation can be found here:
http://learn.getcapi.org

API Doc and Sandbox

https://getcapi.io

AuthorCommitMessageCommit date
44ffcb985b7 Finish changes to token manage methods.  
8d110297de3 Update GET /user/profile to check if user is Guest and prompt to log in first.  
36e2f36d4c5 Update annotationand params calls for postCategoryUpdateById  
1c95db1cc57 Finish building all CRUD token service methods.  
d9ff0d1a4ee Update random token generation algorithm.  
0d29e323773 Remove http scheme from doc  
a761794c3aa Update token generation code.  
3215c0d1750 Add CryptoLib package to Services library  
f271e64ab4e Working on new service method postTokenManageById  
fef58508ac7 Changed filter for token generation.  
92923ac3555 Remove random number appended to generated token.  
0483831bfb5 Update annotation  
d567a4d1aad Update description  
cba47b0d580 Update annotation  
b123e1d4ab3 Point swagger.json location to corresponding service method /slim/swagger  
7e071b449b5 Clearn up annotation  
269c03df8e9 Fix some annotation formatting  
51d5c23df01 Correction to ARS annotation  
20dc77bf4ba Update file header annotation  
af3b7272ed0 Create Swagger annotation for postArsDlidByHeaderNonceDlid  
579ec82a48f Update annotation for getTokenManageByTypeValue  
02a96fe70a0 Update annotation for getTokenManageByTypeValue  
f3dc2d4e969 Fix token annotation  
1ed932656f1 Create Swagger annotation for getTokenManageByTypeValue  
e008a3c2be8 Create Swagger annotation for getTokenManage  
b62fc6b8d97 Create Swagger annotation for getTokenManageAll  
b79ca35f4a8 Create Swagger annotation for getTokenByToken  
161b0cef09e Update annotations  
4013ba294e5 Fix annotation  
5ea9bb276b8 Create Swagger annotation for getCategoryFields and fix a few other annotation errors  
33694c86c6f Update annotations and params calls for putCategoryUpdateById  
8cd73ec9bb8 Create Swagger annotation for postCategoryUpdateById  
04bd8cc8854 Create Swagger annotation for postCategoryCreate  
3aabe8aec59 Create Swagger annotation for getCategoryListByIdContent  
681889fb04f Create Swagger annotation for getCategoryListByIdCategories  
99071f3d421 Create Swagger annotation for getCategoryListByIdCategories  
bf190e14c78 Create Swagger annotation for getCategorySingleById  
3b6f6099544 Create Swagger annotation for getCategoryListAll  
d8ea1fc2d57 Create Swagger annotation for getContentFields  
4e9046a89e1 Create Swagger annotation for deleteContentDeleteByID  
986c76f5026 Update Swagger annotation for putContentUpdateByID  
12127edf907 Create Swagger annotation for putContentUpdateByID and fix some other content methods.  
653ecd8acb8 Swagger annotation for postContentCreate along with fixes to the create content code.  
9597d356ace Create Swagger annotation for postContentCreate  
6ccc5a65652 Corrections to Swagger annotation for getContentItemById  
abebdd2db23 Change path for getContentItemById to /content/item/{id}  
8b422699156 Create Swagger annotation getContentSingleById  
07f779d6f32 Create Swagger annotation for getContentListAll  
a7ab01bdd49 Update annotation  
a5f85e8b2f9 Update annotations  
38b65e16536 Update annotations  
80bc0148a60 Update annotation  
369463155f9 Update annotation  
fb74851a25b Update annotations  
0d578a4fbb5 Update annotation  
75e53253eb9 Update annotation  
98f51078e60 Update annotations  
66c6d11fcad Create Swagger annotation for putUserProfileById  
1131dbf9f07 Create Swagger annotation for putUserProfile  
d42f2765e97 Create Swagger annotation for getUserProfileById  
d48198b39d0 Create Swagger annotation for getUserProfile  
b40f4a845b2 Create Swagger annotation for getUserSessions  
30a8a91e549 Update getUserGroupListUsersById  
cafc6463201 Create Swagger annotation for getUserGroupListAll.  
5a089d837f1 Create Swagger annotation for deleteUserGroupEditById  
69dc0be01e0 Update annotation.  
796f45a4820 Point Swagger UI to locally generated Swagger.json at /api/v1/slim/swagger  
78986c2461b Fix Swagger base path generation.  
a139d9f33ee Create Swagger annotation deleteUserEdit  
1133ff92268 Create Swagger annotation for putUserEdit  
b17298270bd Fix annotations  
53b50463603 Create postUserEdit annotation  
24007a07cb1 Create annotation getLogoutByUsernamePassword  
d6e3719fe8f Update annotations for getUser and getUserDetail  
401018ad339 Update annotations  
77f0ce39a07 Update swagger json path.  
8395e9dd91c Update swagger annotations.  
5995f042bfc Add composer file.  
388c02211e5 Add new libraries to lib_services and update composer files for services directory.  
ad2c8736619 Update  
f11d796966d Fix annotation.  
22d2e635e8e Fix annotation.  
606604fd682 Fix annotation.  
0204614e296 Configure inline Swagger annotation.  
66e9359f2ae Fix install script so it updates the contents of the api folder on subsequent reinstalls.  
26225fc9fa0 Add %%licensename%% regex pattern.  
180d4220918 Add symfony vendor folder to lib_services.  
957243ab3b5 Add palanik vendor library to lib_services  
eae37d8e4ad Increment version to 1.2.5.  
fa46ffb9bbb Add doctrine and zircote vendor libraries to lib_services.  
f874584db18 Clean up spaces.  
de23f4c7a0e Create service method /token/manage/all to return list of all tokens.  
4d12f025624 Fix bugs in /token/manage services route.  
0066f101649 Fix getUserIdbyToken to accomodate + symbol in token.TODO: Should eventually disallow + from token value creation.  
abf5900445a Building tokenManage service methods.  
8f01ba1293a Create service methods for retrieving collections of tokens by userid, username, email, token or current session.  
dbb07fcc122 Expose protected and private functions to public.  
b6926657216 Build method to retrieve user details by id, email, username or token.  
93731d76229 Building token read and create service methods.  
f608f0e9e7b TODO: Restrict access to core.admin except where own session userid matches user id in detail response.  
906dd9d9a16 Incluse userid in response.  
4338e0823bf Updates to Get user details by user ID, username, email or token ID  
e947d5ca5c7 Find user by username in GET /user/detail/:type/:value  
7fca99430ab Create method GET /user/detail/:type/:value  
db4d0142030 Remove aid from GET /user response.  
e769fe7a2ec Update GET /user to include user object details.  
877068c6655 Update comment blocks.

View files

Version 1.2.4 Stable

Released on: Thursday, 19 May 2016 20:00

 

Maturity
Stable
Released on
Thursday, 19 May 2016 20:00

What is cAPI?

Code named "Constant API", cAPI is the fantastic result of an effort to mesh the Slim micro-framework with the Joomla Framework / CMS. Once that goal was accomplished, it soon became obvious that just built a Joomla RESTful API was only the beginning! By leveraging Joomla's advanced "pluggable" architecture and robust ACL, cAPI can transform your website into a true middleware service for anything ranging from SQL servers, MongoDB servers and even Microsoft's Active Directory (think of the SSO possibilities!).

How does it work?

cAPI injects the Slim micro-framework into the Joomla application instance, allowing for service route plugins to be built at any level of the event stack. But that's only the beginning!

A Services Control Panel manages the creation of access tokens, Slim framework parameters and API rate limitation rules. This allows an administrator to create tokens mapped to specific Joomla users who in turn are assigned unique group permissions using Joomla ACL.

The service routes are built into Joomla plugins which can be enabled / disabled or assigned access permissions individually. This opens the door for development of feature expansions to the core cAPI services to expose 3rd party Joomla extensions, database querying or even remote LDAP as RESTful JSON APIs.

cAPI Core v1.2.4 introduces Swagger UI into the Joomla front-end menu and back-end control panel.

Now you can create a public or access-restricted  front-end menu item to expose an interactive Swagger UI API doc and test tool end-users. cAPI also includes a back-end accessible Swagger UI API doc in the Services Control Panel.

Updated documentation can be found here:
http://learn.getcapi.org

API Doc and Sandbox

https://getcapi.io

 

b3c39c4e692 Ensure Swagger UI service request matches HTTP transport method.Moved javascript header scripts into view.html.php.
1187d5e1807 Ensure Swagger UI service request matches HTTP transport method.Moved javascript header scripts into view.html.php.
eb7d7df423a Add COM_SERVICES_TITLE_LIST_VIEW_SWAGGERUI_DESC
c62bcc4d2a3 Comment-out side-bar from swaggerui admin view.
4353db3020f Add COM_SERVICES_TITLE_LIST_VIEW_SWAGGERUI_DESC
bc724ed11a8 Version 1.2.4 includes new built-in Swagger UI admin & front-end views and updates to doc-blocks.
a7adce2624e Remove "msg" parameter heading and return /user/sessions directly.
7ea4971e689 Remove "msg" parameter heading and return /slim/routes directly.

View files

Version 1.1 Stable

Released on: Saturday, 12 December 2015 19:00

 

Maturity
Stable
Released on
Saturday, 12 December 2015 19:00

What is cAPI?

Code named "Constant API", cAPI is the fantastic result of an effort to mesh the Slim micro-framework with the Joomla Framework / CMS. Once that goal was accomplished, it soon became obvious that just built a Joomla RESTful API was only the beginning! By leveraging Joomla's advanced "pluggable" architecture and robust ACL, cAPI can transform your website into a true middleware service for anything ranging from SQL servers, MongoDB servers and even Microsoft's Active Directory (think of the SSO possibilities!).

How does it work?

cAPI injects the Slim micro-framework into the Joomla application instance, allowing for service route plugins to be built at any level of the event stack. But that's only the beginning!

A Services Control Panel manages the creation of access tokens, Slim framework parameters and API rate limitation rules. This allows an administrator to create tokens mapped to specific Joomla users who in turn are assigned unique group permissions using Joomla ACL.

The service routes are built into Joomla plugins which can be enabled / disabled or assigned access permissions individually. This opens the door for development of feature expansions to the core cAPI services to expose 3rd party Joomla extensions, database querying or even remote LDAP as RESTful JSON APIs.

Details coming soon!

IMPORTANT

Certain breaking changes had to be made to the naming convension of the a couple extenions in the core package, requiring a full uninstall before reinstalling v1.1.

View files

Releases per page:

Subscribe To Our Newsletter!

Cron Job Starts