Launchpad manager license key5/18/2023 Serialization allows the LaunchPad API to define the JSON that is returned for each object in the API. This approach follows the proposed RFC-8288 standard for Web linking by using headers for pagination instead of the response body. The LaunchPad API leverages Kaminari in conjunction with the API Pagination gem to provide pagination within your API. Please read here to learn more about creating and modifying your API Documentation. You can customize your API Documentation in spec/acceptance/api/. The API documentation is generated using RSpec API Doc Generator. To get your Basic Auth token, run the following commands: $ rails c By default, the username is launchpad and the password is your LaunchPad License Key.ĪPI requests should be sent with the following header: Key: Authorization The LaunchPad API leverages Basic Auth for authenticating incoming API requests and web traffic to the API documentation. ![]() To learn more about configuring Authorization for your application, see the CanCanCan Wiki. To customize authorization behavior, you can simply modify the app/models/ability.rb file.įor example, to prevent users from creating a new Account, you could add the following line at the bottom of the initialize method. ![]() Authorization of objects and their RESTful actions is built into the API by default. The LaunchPad API comes installed with the popular CanCanCan Authorization Gem. We highly recommend you read this article to learn more about security in Ruby on Rails. ![]() Ruby on Rails comes with excellent security. Each ORM object inherits from app/models/salesforce_model.rb to provide one place to manage the integration with Salesforce. The LaunchPad API depends on Heroku Connect for the Salesforce Integration. You can read more about configuring databases here and managing environment variables here. You can change this by modifying the config/database.yml file or simply changing the DATABASE_URL environment variable for a given environment. Perform database operations in an object-oriented fashion.īy default the LaunchPad API connects directly to your Heroku Postgres database in development mode.Validate models before they get persisted to the database.Represent inheritance hierarchies through related models.Represent associations between these models.As described in this guide, Active Record provides the following key mechanisms: To learn more about Active Record, please read the Active Record Basics Guide. Active Record ORMĮach object generated in the LaunchPad API will have a corresponding Active Record ORM object which can be found in app/models/. If you are unsure whether Ruby on Rails is a fit for your project, we highly recommend that you read the Rails Doctrine to determine if the framework aligns philosophically with your development team. The LaunchPad API leverages Ruby on Rails as the underlying application framework. In the below commands, replace APPNAME with the name of the Heroku app you just deployed: $ git clone APPNAMEįollow the terminal instructions to select the objects you’d like to add to the API.įinally, start your server to view the API documentation: $ rails sĮnter the following credentials: username: launchpad Please make sure Ruby v2.5.1 is installed before proceeding. The API is a Ruby on Rails application that requires Ruby to be installed on your machine. Because of this, the first step is to deploy the LaunchPad API application to Heroku using the Deploy to Heroku button found below. Unlike other Heroku add-ons that can be attached to an existing Heroku app, the LaunchPad add-on must be attached to the LaunchPad API. Without a license key, the installation process will not succeed. The add-on itself simply provides a license key. ![]() Unlike traditional add-ons, this add-on is only useful when attached to the LaunchPad API application that is generated from the Deploy to Heroku button. The add-on is used in conjunction with Heroku Connect, which means that a Salesforce customer can generate a REST API based on their existing Salesforce schema, greatly accelerating the process of building a Salesforce-integrated web or mobile solution. The LaunchPad add-on allows Salesforce customers to build and launch integrated web and mobile applications 2x faster.
0 Comments
Leave a Reply. |