After creating a stream you will be immediately brought to the integration page. Adspect supports several types of integration that differ in technical details and use cases:
- Forward PHP integration via a standalone
- Reverse PHP integration via including a
<script>HTML tag embedding using a remote
Each stream has its own
ajax.php files wired to it that have the stream ID encoded inside.
However, you may override that encoded stream ID and send a click to a different stream by putting the destination
full stream ID into the
__sid URL parameter, e.g:
Click the short stream ID in the streams list to copy the full stream ID into clipboard.
PHP integration comes in two flavors: forward and reverse. They differ only in how our PHP files are wired with your locally hosted landing pages, i.e. which file receives incoming traffic.
Both integration types support several methods for displaying links to external sites, that is, money and white pages specified as URLs in stream settings:
- HTTP redirect – regular redirection to the remote URL via HTTP 302 status code. This is the usual choice in most cases. If you don’t know which display method to choose, then go with HTTP redirect.
- HTML iframe – display the remote URL on your domain inside an
<iframe>tag. Please note that websites may forbid displaying their content inside an iframe by using the X-Frame-Options response header.
- Reverse proxy – display the remote URL on your domain by HTTP request proxying. This method also suffers from several technical complications and should be used only if no other method fits.
Forward PHP Integration¶
In forward PHP integration filtering is done by a special
index.php file that you place in your landing page directory
or elsewhere accessible via HTTP. This file acts as an entry point for web traffic and is wired to our servers that
process clicks and make decisions.
Traffic flow chart
After uploading the
index.php file to your hosting its URL will be the cloaked URL suitable for use in advertising campaigns.
Several copies of the same
index.php file may be used for protecting several offers or landing pages without interfering
with each other except for shared statistics.
Forward PHP integration is the most common type of integration. If you don’t know which integration type to choose, then go with forward PHP integration.
Reverse PHP Integration¶
There’s also a slightly different reverse PHP integration that uses a
filter.php file which is included into your
PHP page file (normally your white page) via a single line of PHP code. Traffic lands directly on this page, our code
filter.php file inspects it and chooses either to keep the visitor on the page or display a different one.
Traffic flow chart
In order to perform reverse PHP integration you first need to download the
filter.php file on the Reverse PHP Integration
tab and put it into the folder of your site or landing page. Several copies of the same
filter.php file may be used for
protecting several sites or landing pages without interfering with each other except for shared statistics.
Then add the following code as the first line of your site or landing page index file (usually named
above all other code:
<?php require __DIR__ . '/filter.php' ?>
If your site is written in pure HTML, then you may safely rename your
index.html or any other HTML file to
any other name ending in
.php before adding the code to it.
If you added the code into your white page, then leave the White Page field empty in the stream settings. Empty field means “no action”, i.e. Adspect will not take any action, leaving the visitor on their current page which is the white page. Likewise, if you added the code into your money page, then leave the Money Page field of your stream empty.
Once set up, you then simply direct traffic to the page you added the code into.
WordPress and Other CMS¶
Reverse PHP integration is useful for integrating Adspect into sites based on WordPress or similar CMS (content management systems.)
WordPress has a file named
index.php in its root folder.
That is the file where you should add that single line of PHP code discussed above. Place the
filter.php file into the same folder.
Most other PHP-based CMS software also has such
index.php entryway files in their root folders.
Traffic flow chart
You will also need to download a PHP file called
ajax.php and host it somewhere, but its final location does not
matter as it will be linked into the white page using a
<script> HTML tag.
It is important to link
ajax.php via HTTPS if the website you are integrating Adspect into also uses HTTPS (which is
almost always the case.) Trying to link
ajax.php to an HTTPS site via plain HTTP will result in
mixed content error in most modern browsers,
and cloaking will not work.
- In iframe overlay mode, legitimate visitors will be shown the money page via an iframe overlay without redirecting them anywhere, i.e. the money page iframe will be placed over the white page. Please note that websites may forbid displaying their content inside an iframe by using the X-Frame-Options response header.
- In passive mode our statistics will be updated, but no further action will be taken–the visitor will remain on the page. This mode is like Google Analytics–perfect for collecting passive insights and blacklists of bot-ridden sources in cases that do not require cloaking.
Several copies of the same
ajax.php file may be used for protecting several pages without interfering with each other
except for shared statistics.
which is the page that our
<script> tag is placed on.
Sometimes integration does not work. The most often observed error is HTTP 500 (internal server error), usually caused by either of the following misconfigurations:
- File specified for zero redirect displaying of money/white page could not be found;
- Your PHP installation does not have cURL support–you need to install the
All Adspect PHP files support debug mode. If enabled, any server-side errors will be displayed directly in browser window. In order to enable debug mode you need to open our PHP file in a text editor, find the following piece of code in the beginning of the file:
<?php define('ADSPECT_DEBUG', 0);
1 in it:
<?php define('ADSPECT_DEBUG', 1);
If your PHP integration does not work, e.g. you observe an HTTP 500 error, then you will see error details in
If you don’t know how to fix a particular error, then please contact us in Telegram about it.
Do not forget to disable debug mode after all errors are fixed.