Once you've created a new organization and property, you can begin to build your new adapter. To begin, navigate to a property within an organization. Once at the Property page, click on New adapter.
On the resulting page, enter a name and description for this adapter. Since many clients create several adapters, we recommend that your description be brief but informative, like the one below. When you're ready to move forward, click Submit.
On the resulting page, you should see the Build area for your adapter. New adapters begin with two (2) components, a Request (incoming) Handler and a Response (outgoing) Type. You can change these end-points by clicking on them.
Click on the Auto GET/POST handler component. On the resulting page, you will see a drop-down list where you can select the handler type.
During the initial setup of an LTI 1.3 external tool in your system, you should be presented with a series of URLs and values that are required for setting up an LTI 1.3 adapter in Apidapter. Therefore, before you will be able to create and save the request handler component of your new LTI 1.3 adapter, you will need the following information:
- Client ID
- Auth Login URL
- Auth Token URL
- Keyset URL
- Deployment ID
For information on using Apidapter for LTI 1.3 integration with a learning management system, please visit the following articles for LMS-specific information:
Once you have added all of the necessary information to the LTI 1.3 request handler, click Save. See our example below:
Take note of the green button between the two components in your new adapter. You can insert any number of additional components within this adapter. The following are the component options; each option is described in a separate article:
- Change case
- Check Apidapter SSO
- Conditional set
- Jump if
- LDAP authenticator
- Prepend append
- Regex substitute
- Sign Apidapter SSO
To insert a new component, click the Green Plus Button, select the type of component, enter the desired parameters, and Save.
Once you have added and saved the desired component you will be directed back to the Build page where you should see the additional component included within your adapter:
You can return to Edit the component by clicking on it again. It can be removed by pressing the down arrow to the right of the component button and hitting Delete.
Note: Adapters process transactions sequentially. Therefore, the ordering of components matters in the overall transformation. For example, if you intend to use the user ID to create an email address, but want to maintain the user ID value in addition to the new email, you would need to be sure to first add a Copy component to the adapter to copy the value of user_id into email_address and then add a Prepend Append component to add the @domain to the email_address. Your adapter would look something like this:
This setup will ensure the correct order of operations within the adapter. If you find that you added a component in the wrong position, you will need to recreate the component in the correct position and then delete the erroneous component.
Once you have added the necessary components, you can then begin the work of updating the final response handler component. To finish the setup of this LTI 1.3 adapter, click on the response handler:
On the resulting page, you will see a drop-down list where you can select the handler type. Select lti 1.3 response from the drop-down:
On the resulting page, notice the values in the Client ID and Deployment ID fields are autogenerated by Apidapter. You will need these values for the creation of the new LTI 1.3 tool in your system. The Initiate Login URL and Redirection URI should be provided by the system within which you are creating the new LTI 1.3 tool. The image below represents an example of a completed LTI 1.3 response type:
When you have entered all of the required information, click Save. Upon saving, you should then see your completed LTI 1.3 adapter:
When you're finished building your adapter click Done to the right of the adapter name. Remember to take your adapter out of debug mode when you are ready to start passing transactions on to the destination endpoint.