Tulo Paywall - API-Only¶
Target audience: Developers, Stakeholders
This document describes how you can integrate with the Tulo Paywall using the API-only method.
Create a Tulo Paywall API user¶
To enable communication between your site and Payway you need to create a Tulo Paywall API user. The API user must include the following scopes:
Once you have your API user successfully created, you'll need to contact our support to enable the Tulo Paywalls feature.
Create your first Tulo Paywall¶
Once Tulo Paywalls have been enabled, you will be able to navigate to Marketing => Paywalls in the PAP and create your first paywall. To get started, we recommend you check out our guide in creating a Tulo Paywall.
Preparing your site¶
Great job! If you got this far, you got your API user ready to go, and your first Tulo Paywall standing by. If you would like to fully or partially utilise the default Paywall styling, you can include our Tulo Paywall CSS on your site. Choose the right file depending on what environment you are working in.
Embedding your Tulo Paywall¶
To embed your paywall, a request to our Get Paywall endpoint will have to be made and at a bare minimum, the title code of the paywall will have to be known.
Using this endpoint will allow you to render your Tulo Paywall either directly via the returned
markup-property, or indirectly by making use of the
resource variables that you specified earlier in Step 2.
Test & go live¶
Once everything above is said and done, we highly recommend you take some final steps before publishing your Tulo Paywall to a production environment:
- Test your Tulo Paywall and implementation in a testing/staging environment.
- Make sure the Tulo Paywall renders correctly.