REST API

The REST API package allows you to quickly and efficiently develop a secure and robust JSON based REST APIs for any purpose. If you do not already have the rest_api package installed, you may install it by typing the following within terminal from the Apex installation directory:

./apex install rest_api

This page will guide you through the setup process, and please see the below links for full information on how to develop out your desired API endpoints. Please note, you may view the /src/rest_api/examples directory for example code of both, how to develop API endpoints, and how to integrate with the API as a client.

1. Authentication Schemas
   1. API Provider Keys
   2. Access / Refresh Tokens
      1. POST /core/login
      2. POST /core/refresh_token
      3. GET /core/logout
   3. Simple API / Public + Secret Keys
   4. Login Credentials
2. API Development
   1. Routing / rest_api.php Class
      1. Default Routes
      2. $routes Property
      3. $acl Property
   2. 1. JSON Response Object
   3. api_util Functions
      1. check_required()
      2. decrypt
      3. create_session()
      4. Exceptions
3. RSA Encryption
   1. RSA Key-Pair
   2. GET /core/rsa_key
   3. Encryption
   4. Decryption

Getting Started

After installation of the rest_api package, visit the Settings->REST API menu of the administration panel where you will be prompted to complete setup. Most of this page should be straight forward with the given explanations except for the authentication schema. This can not be changed after setup unless you reset the system, and below explains the different authentication schemas available.

For all other details regarind gthe REST API package, please use the above links. Alos, you may view example code of both server and client side implementation via the /src/rest_api/examples/ directory of your Apex installation.

No comments yet.

Add Comment

You must be logged in to submit a comment.